vtkCPPythonScriptPipeline.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkCPPythonScriptPipeline.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 #ifndef vtkCPPythonScriptPipeline_h
16 #define vtkCPPythonScriptPipeline_h
17 
18 #include "vtkCPPythonPipeline.h"
19 #include "vtkPVPythonCatalystModule.h" // For windows import/export of shared libraries
20 
22 
29 {
30 public:
33  void PrintSelf(ostream& os, vtkIndent indent) override;
34 
37  int Initialize(const char* fileName);
38 
46  virtual int RequestDataDescription(vtkCPDataDescription* dataDescription) override;
47 
49  virtual int CoProcess(vtkCPDataDescription* dataDescription) override;
50 
53  virtual int Finalize() override;
54 
55 protected:
57  virtual ~vtkCPPythonScriptPipeline();
58 
60  vtkSetStringMacro(PythonScriptName);
61  vtkGetStringMacro(PythonScriptName);
62 
63 private:
65  void operator=(const vtkCPPythonScriptPipeline&) = delete;
66 
69  char* PythonScriptName;
70 };
71 
72 #endif
#define VTKPVPYTHONCATALYST_EXPORT
void PrintSelf(ostream &os, vtkIndent indent) override
virtual int RequestDataDescription(vtkCPDataDescription *dataDescription)=0
Configuration Step: The coprocessor first determines if any coprocessing needs to be done at this Tim...
virtual int CoProcess(vtkCPDataDescription *dataDescription)=0
Execute the pipeline. Returns 1 for success and 0 for failure.
Abstract class that takes care of initializing Catalyst Python pipelines for all concrete implementat...
virtual int Finalize()
Finalize the pipeline before deleting it.
Class that creates a coprocessing pipeline starting from a coprocessing script.
static vtkObject * New()
This class provides the description of the data for the coprocessor pipelines.