vtkInSituPipelinePython.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-License-Identifier: BSD-3-Clause
12 #ifndef vtkInSituPipelinePython_h
13 #define vtkInSituPipelinePython_h
14 
15 #include "vtkInSituPipeline.h"
16 #include "vtkNew.h" // for vtkNew.
17 #include <string> // for std::string
18 #include <vector> // for std::vector
19 
21 
22 class VTKPVINSITU_EXPORT vtkInSituPipelinePython : public vtkInSituPipeline
23 {
24 public:
25  static vtkInSituPipelinePython* New();
27  void PrintSelf(ostream& os, vtkIndent indent) override;
28 
30 
34  vtkSetStringMacro(FileName);
35  vtkGetStringMacro(FileName);
37 
39 
43  void SetArguments(const std::vector<std::string>& args);
44  const std::vector<std::string>& GetArguments() const { return this->Arguments; }
46 
48 
51  void SetParameters(const std::vector<std::string>& params);
52  const std::vector<std::string>& GetParameters() const { return this->Parameters; }
54 
56 
59  bool Initialize() override;
60  bool Execute(int, double) override;
61  bool Finalize() override;
63 
64 protected:
66  ~vtkInSituPipelinePython() override;
67 
68 private:
70  void operator=(const vtkInSituPipelinePython&) = delete;
71 
73  char* FileName;
74  std::vector<std::string> Arguments;
75  std::vector<std::string> Parameters;
76 };
77 
78 #endif
vtkInSituPipeline::Initialize
virtual bool Initialize()
Initialize is called once before the first call to 'Execute'.
Definition: vtkInSituPipeline.h:44
vtkInSituPipeline::Execute
virtual bool Execute(int timestep, double time)=0
vtkInSituPipeline::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
vtkObject::New
static vtkObject * New()
vtkInSituPipeline
abstract base class for all in situ pipelines.
Definition: vtkInSituPipeline.h:35
vtkInSituPipelinePython::GetParameters
const std::vector< std::string > & GetParameters() const
Get/Set the execute parameters.
Definition: vtkInSituPipelinePython.h:52
vtkIndent
vtkNew< vtkCPPythonScriptV2Helper >
vtkInSituPipelinePython
subclass for Python in situ scripts.
Definition: vtkInSituPipelinePython.h:22
vtkNew.h
vtkInSituPipelinePython::GetArguments
const std::vector< std::string > & GetArguments() const
Get/Set the arguments.
Definition: vtkInSituPipelinePython.h:44
vtkInSituPipeline.h
vtkInSituPipeline::Finalize
virtual bool Finalize()
Called once before the in situ analysis is finalized.
Definition: vtkInSituPipeline.h:54
vtkCPPythonScriptV2Helper
an internal class encapsulating logic for Catalyst Python scripts.
Definition: vtkCPPythonScriptV2Helper.h:23