ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkCPPipeline Class Referenceabstract

Generic interface for operating on pipelines. More...

#include <vtkCPPipeline.h>

Inheritance diagram for vtkCPPipeline:
Inheritance graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int RequestDataDescription (vtkCPDataDescription *DataDescription)=0
 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)=0
 Execute the pipeline. Returns 1 for success and 0 for failure. More...
 
virtual int Finalize ()
 Finalize the pipeline before deleting it. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkCPPipelineSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkCPPipeline ()
 
virtual ~vtkCPPipeline ()
 

Detailed Description

Generic interface for operating on pipelines.

The user can use this if they only have a single pipeline that they want to operate on or they can use this to create a single pipeline and add it to vtkCPProcessor. Each derived class should set itself up before adding itself to vtkCPProcessor.

Definition at line 29 of file vtkCPPipeline.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkCPPipeline::Superclass

Definition at line 32 of file vtkCPPipeline.h.

Constructor & Destructor Documentation

◆ vtkCPPipeline()

vtkCPPipeline::vtkCPPipeline ( )
protected

◆ ~vtkCPPipeline()

virtual vtkCPPipeline::~vtkCPPipeline ( )
protectedvirtual

Member Function Documentation

◆ GetClassName()

virtual const char* vtkCPPipeline::GetClassName ( )
virtual

Reimplemented in vtkCPPythonScriptPipeline.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkCPPythonScriptPipeline.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ RequestDataDescription()

virtual int vtkCPPipeline::RequestDataDescription ( vtkCPDataDescription DataDescription)
pure 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.

Implemented in vtkCPPythonScriptPipeline.

◆ CoProcess()

virtual int vtkCPPipeline::CoProcess ( vtkCPDataDescription DataDescription)
pure virtual

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

Implemented in vtkCPPythonScriptPipeline.

◆ Finalize()

virtual int vtkCPPipeline::Finalize ( )
virtual

Finalize the pipeline before deleting it.

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

Reimplemented in vtkCPPythonScriptPipeline.


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