ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
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]

Public Types

typedef vtkCPPipeline Superclass
 
- Public Types inherited from vtkCPPipeline
typedef vtkObject Superclass
 

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. More...
 
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. More...
 
virtual int CoProcess (vtkCPDataDescription *dataDescription)
 Execute the pipeline. Returns 1 for success and 0 for failure. More...
 
virtual int Finalize ()
 Finalize the pipeline before deleting it. More...
 
- Public Member Functions inherited from vtkCPPipeline
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkCPPythonScriptPipelineNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCPPythonScriptPipelineSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkCPPipeline
static int IsTypeOf (const char *type)
 
static vtkCPPipelineSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkCPPythonScriptPipeline ()
 
virtual ~vtkCPPythonScriptPipeline ()
 
vtkStdString GetPythonAddress (void *pointer)
 Return the address of Pointer for the python script. More...
 
virtual void SetPythonScriptName (const char *)
 Set/get macro functinos for setting PythonScriptName. More...
 
virtual char * GetPythonScriptName ()
 
- Protected Member Functions inherited from vtkCPPipeline
 vtkCPPipeline ()
 
virtual ~vtkCPPipeline ()
 

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.

Definition at line 29 of file vtkCPPythonScriptPipeline.h.

Member Typedef Documentation

§ Superclass

Definition at line 33 of file vtkCPPythonScriptPipeline.h.

Constructor & Destructor Documentation

§ vtkCPPythonScriptPipeline()

vtkCPPythonScriptPipeline::vtkCPPythonScriptPipeline ( )
protected

§ ~vtkCPPythonScriptPipeline()

virtual vtkCPPythonScriptPipeline::~vtkCPPythonScriptPipeline ( )
protectedvirtual

Member Function Documentation

§ New()

static vtkCPPythonScriptPipeline* vtkCPPythonScriptPipeline::New ( )
static

§ GetClassName()

virtual const char* vtkCPPythonScriptPipeline::GetClassName ( )
virtual

Reimplemented from vtkCPPipeline.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkCPPipeline.

§ SafeDownCast()

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

§ PrintSelf()

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

§ Initialize()

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.

§ RequestDataDescription()

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.

§ CoProcess()

virtual int vtkCPPythonScriptPipeline::CoProcess ( vtkCPDataDescription dataDescription)
virtual

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

Implements vtkCPPipeline.

§ Finalize()

virtual int vtkCPPythonScriptPipeline::Finalize ( )
virtual

Finalize the pipeline before deleting it.

A default no-op implementation is given. Returns 1 for success and 0 for failure.

Reimplemented from vtkCPPipeline.

§ GetPythonAddress()

vtkStdString vtkCPPythonScriptPipeline::GetPythonAddress ( void *  pointer)
protected

Return the address of Pointer for the python script.

§ SetPythonScriptName()

virtual void vtkCPPythonScriptPipeline::SetPythonScriptName ( const char *  )
protectedvirtual

Set/get macro functinos for setting PythonScriptName.

§ GetPythonScriptName()

virtual char* vtkCPPythonScriptPipeline::GetPythonScriptName ( )
protectedvirtual

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