vtkInSituInitializationHelper.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    vtkInSituInitializationHelper.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkInSituInitializationHelper_h
#define vtkInSituInitializationHelper_h

#include "vtkObject.h"
#include "vtkPVInSituModule.h" // For windows import/export of shared libraries

class vtkCPCxxHelper;
class vtkInSituPipeline;
class vtkSMSourceProxy;

#include <string> // for std::string

class VTKPVINSITU_EXPORT vtkInSituInitializationHelper : public vtkObject
{
public:
  vtkTypeMacro(vtkInSituInitializationHelper, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static void Initialize(vtkTypeUInt64 comm);

  static void Finalize();

  static void AddPipeline(const std::string& path);

  static void AddPipeline(vtkInSituPipeline* pipeline);

  static void SetProducer(const std::string& channelName, vtkSMSourceProxy* producer);

  static vtkSMSourceProxy* GetProducer(const std::string& channelName);

  static void UpdateAllProducers(double time);


  static void MarkProducerModified(const std::string& channelName);
  static void MarkProducerModified(vtkSMSourceProxy* producer);

  static bool ExecutePipelines(int timestep, double time);


  static int GetTimeStep();
  static double GetTime();

  static bool IsInitialized() { return vtkInSituInitializationHelper::Internals != nullptr; }

  static bool IsPythonSupported();

protected:
  vtkInSituInitializationHelper();
  ~vtkInSituInitializationHelper();

private:
  vtkInSituInitializationHelper(const vtkInSituInitializationHelper&) = delete;
  void operator=(const vtkInSituInitializationHelper&) = delete;

  static int WasInitializedOnce;
  static int WasFinalizedOnce;

  class vtkInternals;
  static vtkInternals* Internals;
};

#endif