vtkCPPythonScriptV2Helper.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkCPPythonScriptV2Helper_h
#define vtkCPPythonScriptV2Helper_h
 
#include "vtkObject.h"
#include "vtkPVPythonCatalystModule.h" // For windows import/export of shared libraries
#include <string>                      // for std::string
#include <vector>                      //for std::string
 
class vtkSMProxy;
class vtkCPDataDescription;
class vtkStringList;
 
class VTKPVPYTHONCATALYST_EXPORT vtkCPPythonScriptV2Helper : public vtkObject
{
public:
  static vtkCPPythonScriptV2Helper* New();
  vtkTypeMacro(vtkCPPythonScriptV2Helper, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  bool PrepareFromScript(const std::string& fname);
 
  const std::string& GetScriptFileName() const;
 
  bool IsImported() const;
 
  bool Import(const std::vector<std::string>& args = {});
 
  bool CatalystInitialize();
 
  bool CatalystFinalize();
 
  bool CatalystExecute(int timestep, double time, const std::vector<std::string>& params = {});
 
 
  bool Import(vtkCPDataDescription* desc);
  bool CatalystInitialize(vtkCPDataDescription* desc);
  bool RequestDataDescription(vtkCPDataDescription* desc);
  bool CatalystExecute(vtkCPDataDescription* desc);
 
 
  static vtkCPPythonScriptV2Helper* GetActiveInstance();
  void RegisterExtractor(vtkSMProxy* extractor);
  void RegisterView(vtkSMProxy* view);
  void SetOptions(vtkSMProxy* catalystOptions);
  vtkGetObjectMacro(Options, vtkSMProxy);
  vtkCPDataDescription* GetDataDescription() const { return this->DataDescription; }
  vtkSMProxy* GetTrivialProducer(const char* inputname);
  vtkStringList* GetArgumentsAsStringList() const;
  vtkStringList* GetParametersAsStringList() const;
 
protected:
  vtkCPPythonScriptV2Helper();
  ~vtkCPPythonScriptV2Helper() override;
 
  bool IsActivated(int timestep, double time);
  bool IsLiveActivated();
  void DoLive(int, double);
 
private:
  vtkCPPythonScriptV2Helper(const vtkCPPythonScriptV2Helper&) = delete;
  void operator=(const vtkCPPythonScriptV2Helper&) = delete;
 
  class vtkInternals;
  vtkInternals* Internals;
  vtkSMProxy* Options;
  std::string Filename;
  vtkCPDataDescription* DataDescription;
 
  static vtkCPPythonScriptV2Helper* ActiveInstance;
};
 
#endif