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]
Collaboration diagram for vtkCPPipeline:
Collaboration 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) override
 
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...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkCPPipelineSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkCPPipeline ()
 
virtual ~vtkCPPipeline ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

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

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ 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 vtkCPPythonScriptV2Pipeline, vtkCPPythonScriptPipeline, vtkCPPythonStringPipeline, vtkParticlePipeline, and vtkCPXMLPWriterPipeline.

◆ CoProcess()

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

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

Implemented in vtkCPPythonScriptV2Pipeline, vtkCPPythonScriptPipeline, vtkCPPythonStringPipeline, vtkParticlePipeline, and vtkCPXMLPWriterPipeline.

◆ 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 vtkCPPythonScriptV2Pipeline, vtkCPPythonScriptPipeline, and vtkCPPythonStringPipeline.


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