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 
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 Results() override;
62  bool Finalize() override;
64 
65 protected:
67  ~vtkInSituPipelinePython() override;
68 
69 private:
71  void operator=(const vtkInSituPipelinePython&) = delete;
72 
74  char* FileName;
75  std::vector<std::string> Arguments;
76  std::vector<std::string> Parameters;
77 };
78 
79 #endif
virtual bool Initialize()
Initialize is called once before the first call to &#39;Execute&#39;.
virtual bool Execute(int timestep, double time)=0
const std::vector< std::string > & GetArguments() const
Get/Set the arguments.
void PrintSelf(ostream &os, vtkIndent indent) override
an internal class encapsulating logic for Catalyst Python scripts.
const std::vector< std::string > & GetParameters() const
Get/Set the execute parameters.
#define VTKPVINSITU_EXPORT
subclass for Python in situ scripts.
abstract base class for all in situ pipelines.
static vtkObject * New()
virtual bool Results()
virtual bool Finalize()
Called once before the in situ analysis is finalized.