ParaView
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 "vtkCPPipeline.h"
19 #include "vtkPVPythonCatalystModule.h" // For windows import/export of shared libraries
20 #include "vtkStdString.h" // for the string
21 
23 
29 class VTKPVPYTHONCATALYST_EXPORT vtkCPPythonScriptPipeline : public vtkCPPipeline
30 {
31 public:
32  static vtkCPPythonScriptPipeline* New();
34  void PrintSelf(ostream& os, vtkIndent indent);
35 
38  int Initialize(const char* fileName);
39 
47  virtual int RequestDataDescription(vtkCPDataDescription* dataDescription);
48 
50  virtual int CoProcess(vtkCPDataDescription* dataDescription);
51 
54  virtual int Finalize();
55 
56 protected:
58  virtual ~vtkCPPythonScriptPipeline();
59 
61  vtkStdString GetPythonAddress(void* pointer);
62 
64  vtkSetStringMacro(PythonScriptName);
65  vtkGetStringMacro(PythonScriptName);
66 
67 private:
68  vtkCPPythonScriptPipeline(const vtkCPPythonScriptPipeline&) VTK_DELETE_FUNCTION;
69  void operator=(const vtkCPPythonScriptPipeline&) VTK_DELETE_FUNCTION;
70 
73  char* PythonScriptName;
74 };
75 
76 #endif
virtual int RequestDataDescription(vtkCPDataDescription *DataDescription)=0
Configuration Step: The coprocessor first determines if any coprocessing needs to be done at this Tim...
void PrintSelf(ostream &os, vtkIndent indent)
virtual int CoProcess(vtkCPDataDescription *DataDescription)=0
Execute the pipeline. Returns 1 for success and 0 for failure.
Generic interface for operating on pipelines.
Definition: vtkCPPipeline.h:29
virtual int Finalize()
Finalize the pipeline before deleting it.
Class that creates a coprocessing pipeline starting from a coprocessing script.
This class provides the description of the data for the coprocessor pipelines.