Abstract class that takes care of initializing Catalyst Python pipelines for all concrete implementations and adds in some useful helper methods. More...

#include <vtkCPPythonPipeline.h>

Inheritance diagram for vtkCPPythonPipeline:

[legend]

Collaboration diagram for vtkCPPythonPipeline:

[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) override

Public Member Functions inherited from vtkCPPipeline
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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkCPPythonPipeline *	SafeDownCast (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< vtkCPPythonPipeline >	CreatePipeline (const char *fname, int default_version=1)
	Detects the script version, if possible and created appropriate subclass. More...

static vtkSmartPointer< vtkCPPythonPipeline >	CreateAndInitializePipeline (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 vtkCPPythonPipeline *	NewPipeline (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 vtkCPPythonPipeline *	NewAndInitializePipeline (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 vtkCPPipeline *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
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 ()

	~vtkCPPipeline () override

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

Abstract class that takes care of initializing Catalyst Python pipelines for all concrete implementations and adds in some useful helper methods.

Definition at line 17 of file vtkCPPythonPipeline.h.

Member Typedef Documentation

◆ Superclass

typedef vtkCPPipeline vtkCPPythonPipeline::Superclass

Definition at line 20 of file vtkCPPythonPipeline.h.

Constructor & Destructor Documentation

◆ vtkCPPythonPipeline()

vtkCPPythonPipeline::vtkCPPythonPipeline ( )

protected

◆ ~vtkCPPythonPipeline()

vtkCPPythonPipeline::~vtkCPPythonPipeline ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkCPPythonPipeline::GetClassName ( )

virtual

Reimplemented from vtkCPPipeline.

Reimplemented in vtkCPPythonScriptV2Pipeline, vtkCPPythonScriptPipeline, and vtkCPPythonStringPipeline.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkCPPipeline.

Reimplemented in vtkCPPythonScriptV2Pipeline, vtkCPPythonScriptPipeline, and vtkCPPythonStringPipeline.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkCPPipeline.

Reimplemented in vtkCPPythonScriptV2Pipeline, vtkCPPythonScriptPipeline, and vtkCPPythonStringPipeline.

◆ DetectScriptVersion()

static int vtkCPPythonPipeline::DetectScriptVersion ( const char * fname )

static

Starting with ParaView 5.9, there are two versions of Python scripts that ParaView supports.

Use this method to detect which version it is. Returns 1, 2 to indicate script version or 0 on failure.

◆ CreatePipeline()

static vtkSmartPointer<vtkCPPythonPipeline> vtkCPPythonPipeline::CreatePipeline	(	const char *	fname,
		int	default_version = `1`
	)

static

Detects the script version, if possible and created appropriate subclass.

If the version cannot be determined, the default_version is assumed.

See also: CreateAndInitializePipeline.

◆ CreateAndInitializePipeline()

static vtkSmartPointer<vtkCPPythonPipeline> vtkCPPythonPipeline::CreateAndInitializePipeline	(	const char *	fname,
		int	default_version = `1`
	)

static

Same as CreatePipeline, except that if the pipeline instance is successfully created also calls appropriate Initialize method on it.

If the Initialize failed, this will return nullptr.

◆ NewPipeline()

static VTK_NEWINSTANCE vtkCPPythonPipeline* vtkCPPythonPipeline::NewPipeline	(	const char *	fname,
		int	default_version = `1`
	)

static

These overloads are provided for Python wrapping since vtkSmartPointer doesn't seem to be wrapped correctly.

C++ code should avoid using these. Use the Create* variants instead.

◆ NewAndInitializePipeline()

static VTK_NEWINSTANCE vtkCPPythonPipeline* vtkCPPythonPipeline::NewAndInitializePipeline	(	const char *	fname,
		int	default_version = `1`
	)

static

These overloads are provided for Python wrapping since vtkSmartPointer doesn't seem to be wrapped correctly.

C++ code should avoid using these. Use the Create* variants instead.

◆ FixEOL()

void vtkCPPythonPipeline::FixEOL ( std::string & )

protected

For things like programmable filters that have a '
' in their strings, we need to fix them to have \n so that everything works smoothly.

◆ GetPythonAddress()

std::string vtkCPPythonPipeline::GetPythonAddress ( void * pointer )

protected

Return the address of Pointer for the python script.

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

/builds/gitlab-kitware-sciviz-ci/Clients/PythonCatalyst/vtkCPPythonPipeline.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkCPPythonPipeline()

◆ ~vtkCPPythonPipeline()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ DetectScriptVersion()

◆ CreatePipeline()

◆ CreateAndInitializePipeline()

◆ NewPipeline()

◆ NewAndInitializePipeline()

◆ FixEOL()

◆ GetPythonAddress()