ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkCPPythonScriptPipeline Class Reference

Class that creates a coprocessing pipeline starting from a coprocessing script. More...

#include <vtkCPPythonScriptPipeline.h>

Inheritance diagram for vtkCPPythonScriptPipeline:
Inheritance graph
[legend]
Collaboration diagram for vtkCPPythonScriptPipeline:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
int Initialize (const char *fileName)
 Initialize this pipeline from given the file name of a python script.
virtual int RequestDataDescription (vtkCPDataDescription *dataDescription)
 Configuration Step: The coprocessor first determines if any coprocessing needs to be done at this TimeStep/Time combination returning 1 if it does and 0 otherwise.
virtual int CoProcess (vtkCPDataDescription *dataDescription)
 Execute the pipeline. Returns 1 for success and 0 for failure.

Static Public Member Functions

static vtkCPPythonScriptPipelineNew ()
static int IsTypeOf (const char *type)
static vtkCPPythonScriptPipelineSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkCPPythonScriptPipeline ()
virtual ~vtkCPPythonScriptPipeline ()
vtkStdString GetPythonAddress (void *pointer)
 Return the address of Pointer for the python script.
virtual void SetPythonScriptName (const char *)
 Set/get macro functinos for setting PythonScriptName.
virtual char * GetPythonScriptName ()

Detailed Description

Class that creates a coprocessing pipeline starting from a coprocessing script.

This class only does operations with respect to the script and uses the name of the script as the module to hide its definitions from other python modules. Python is primarily set up in vtkCPPythonHelper where it loads servermanager, the coprocessing library and the trivial producer used to get the grid into the script.

Definition at line 32 of file vtkCPPythonScriptPipeline.h.


Constructor & Destructor Documentation

vtkCPPythonScriptPipeline::vtkCPPythonScriptPipeline ( ) [protected]
virtual vtkCPPythonScriptPipeline::~vtkCPPythonScriptPipeline ( ) [protected, virtual]

Member Function Documentation

static vtkCPPythonScriptPipeline* vtkCPPythonScriptPipeline::New ( ) [static]

Reimplemented from vtkObject.

virtual const char* vtkCPPythonScriptPipeline::GetClassName ( ) [virtual]

Reimplemented from vtkCPPipeline.

static int vtkCPPythonScriptPipeline::IsTypeOf ( const char *  type) [static]

Reimplemented from vtkCPPipeline.

virtual int vtkCPPythonScriptPipeline::IsA ( const char *  type) [virtual]

Reimplemented from vtkCPPipeline.

static vtkCPPythonScriptPipeline* vtkCPPythonScriptPipeline::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkCPPipeline.

void vtkCPPythonScriptPipeline::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Reimplemented from vtkCPPipeline.

int vtkCPPythonScriptPipeline::Initialize ( const char *  fileName)

Initialize this pipeline from given the file name of a python script.

Returns 1 for success and 0 for failure.

virtual int vtkCPPythonScriptPipeline::RequestDataDescription ( vtkCPDataDescription dataDescription) [virtual]

Configuration Step: The coprocessor first determines if any coprocessing needs to be done at this TimeStep/Time combination returning 1 if it does and 0 otherwise.

If coprocessing does need to be performed this time step it fills in the FieldNames array that the coprocessor requires in order to fulfill all the coprocessing requests for this TimeStep/Time combination.

Implements vtkCPPipeline.

virtual int vtkCPPythonScriptPipeline::CoProcess ( vtkCPDataDescription dataDescription) [virtual]

Execute the pipeline. Returns 1 for success and 0 for failure.

Implements vtkCPPipeline.

vtkStdString vtkCPPythonScriptPipeline::GetPythonAddress ( void *  pointer) [protected]

Return the address of Pointer for the python script.

virtual void vtkCPPythonScriptPipeline::SetPythonScriptName ( const char *  ) [protected, virtual]

Set/get macro functinos for setting PythonScriptName.

virtual char* vtkCPPythonScriptPipeline::GetPythonScriptName ( ) [protected, virtual]

The documentation for this class was generated from the following file: