vtkInSituInitializationHelper.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkInSituInitializationHelper_h
#define vtkInSituInitializationHelper_h

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

class vtkCPCxxHelper;
class vtkInSituPipeline;
class vtkSMProxy;
class vtkSMSourceProxy;
// forward declare conduit_node and its typedef.
// it has to be identical to the one in conduit.hpp
struct conduit_node_impl;
typedef struct conduit_node_impl conduit_node;

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

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

  static void Initialize(vtkTypeUInt64 comm, const std::vector<std::string>& python_paths);

  static void Finalize();

  static vtkInSituPipeline* AddPipeline(const std::string& pipeline_name, const std::string& path);

  static vtkInSituPipeline* GetPipeline(const std::string& pipeline_name);

  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,
    const std::vector<std::string>& pipelines = {},
    const std::vector<std::string>& parameters = {});

  // This overload accept the "catalyst/state" node of the ParaView Blueprint.
  // When using this overload the conduit node will become available also via the catalyst script
  static bool ExecutePipelines(const conduit_node* catalyst_state);

  static bool GetResultsFromPipelines(conduit_node* catalyst_params);


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

  static conduit_node* GetCatalystParameters();

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

  static bool IsPythonSupported();

  static void GetSteerableProxies(std::vector<std::pair<std::string, vtkSMProxy*>>& proxies);

  static void UpdateSteerableParameters(
    vtkSMProxy* steerableProxy, const char* steerableSourceName);

protected:
  vtkInSituInitializationHelper();
  ~vtkInSituInitializationHelper() override;

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

  static void UpdateSteerableProxies();
  static int GetAttributeTypeFromString(const std::string& associationString);

  static int WasInitializedOnce;
  static int WasFinalizedOnce;

  class vtkInternals;
  static vtkInternals* Internals;
};

#endif