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 vtkCPPythonPipeline Superclass
 
- Public Types inherited from vtkCPPythonPipeline
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) override
 
int Initialize (const char *fileName)
 Initialize this pipeline from given the file name of a python script. More...
 
virtual int RequestDataDescription (vtkCPDataDescription *dataDescription) override
 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) override
 Execute the pipeline. Returns 1 for success and 0 for failure. More...
 
virtual int Finalize () override
 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 vtkCPPythonScriptPipelineNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCPPythonScriptPipelineSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkCPPythonPipeline
static int IsTypeOf (const char *type)
 
static vtkCPPythonPipelineSafeDownCast (vtkObject *o)
 
static int DetectScriptVersion (const char *fname)
 Starting with ParaView 5.9, there are two versions of Python scripts that ParaView supports. More...
 
static vtkSmartPointer< vtkCPPythonPipelineCreatePipeline (const char *fname, int default_version=1)
 Detects the script version, if possible and created appropriate subclass. More...
 
static vtkSmartPointer< vtkCPPythonPipelineCreateAndInitializePipeline (const char *fname, int default_version=1)
 Same as CreatePipeline, except that if the pipeline instance is successfully created also calls appropriate Initialize method on it. More...
 
static VTK_NEWINSTANCE vtkCPPythonPipelineNewPipeline (const char *fname, int default_version=1)
 These overloads are provided for Python wrapping since vtkSmartPointer doesn't seem to be wrapped correctly. More...
 
static VTK_NEWINSTANCE vtkCPPythonPipelineNewAndInitializePipeline (const char *fname, int default_version=1)
 These overloads are provided for Python wrapping since vtkSmartPointer doesn't seem to be wrapped correctly. More...
 
- Static Public Member Functions inherited from vtkCPPipeline
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

 vtkCPPythonScriptPipeline ()
 
virtual ~vtkCPPythonScriptPipeline ()
 
virtual void SetPythonScriptName (const char *)
 Set/get macro functinos for setting PythonScriptName. More...
 
virtual char * GetPythonScriptName ()
 
- Protected Member Functions inherited from vtkCPPythonPipeline
void FixEOL (std::string &)
 For things like programmable filters that have a '
' in their strings, we need to fix them to have \n so that everything works smoothly. More...
 
std::string GetPythonAddress (void *pointer)
 Return the address of Pointer for the python script. More...
 
 vtkCPPythonPipeline ()
 
 ~vtkCPPythonPipeline () override
 
- Protected Member Functions inherited from vtkCPPipeline
 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

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 28 of file vtkCPPythonScriptPipeline.h.

Member Typedef Documentation

◆ Superclass

Definition at line 32 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 vtkCPPythonPipeline.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkCPPythonPipeline.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkCPPipeline.

◆ 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)
overridevirtual

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)
overridevirtual

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

Implements vtkCPPipeline.

◆ Finalize()

virtual int vtkCPPythonScriptPipeline::Finalize ( )
overridevirtual

Finalize the pipeline before deleting it.

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

Reimplemented from vtkCPPipeline.

◆ 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: