subclass for Python in situ scripts. More...

#include <vtkInSituPipelinePython.h>

Inheritance diagram for vtkInSituPipelinePython:

Collaboration diagram for vtkInSituPipelinePython:

[legend]

Public Types
typedef vtkInSituPipeline	Superclass

Public Types inherited from vtkInSituPipeline
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override


virtual void	SetFileName (const char *)
	Get/Set the path to either a .py file or a .zip file or a Python package directory. More...

virtual char *	GetFileName ()
	Get/Set the path to either a .py file or a .zip file or a Python package directory. More...


void	SetArguments (const std::vector< std::string > &args)
	Get/Set the arguments. More...

const std::vector< std::string > &	GetArguments () const
	Get/Set the arguments. More...


void	SetParameters (const std::vector< std::string > &params)
	Get/Set the execute parameters. More...

const std::vector< std::string > &	GetParameters () const
	Get/Set the execute parameters. More...


bool	Initialize () override
	vtkInSituPipeline API implementation. More...

bool	Execute (int, double) override
	vtkInSituPipeline API implementation. More...

bool	Results () override
	vtkInSituPipeline API implementation. More...

bool	Finalize () override
	vtkInSituPipeline API implementation. More...

Public Member Functions inherited from vtkInSituPipeline
virtual char *	GetName ()
	Name is used to identify individual pipelines. More...

virtual void	SetName (const char *)

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

static int	IsTypeOf (const char *type)

static vtkInSituPipelinePython *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkInSituPipeline
static int	IsTypeOf (const char *type)

static vtkInSituPipeline *	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
	vtkInSituPipelinePython ()

	~vtkInSituPipelinePython () override

Protected Member Functions inherited from vtkInSituPipeline
	vtkInSituPipeline ()

	~vtkInSituPipeline () 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 vtkInSituPipeline
char *	Name

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

subclass for Python in situ scripts.

vtkInSituPipelinePython supports loading ParaView Python scripts for in situ analysis.

Definition at line 22 of file vtkInSituPipelinePython.h.

Member Typedef Documentation

◆ Superclass

typedef vtkInSituPipeline vtkInSituPipelinePython::Superclass

Definition at line 26 of file vtkInSituPipelinePython.h.

Constructor & Destructor Documentation

◆ vtkInSituPipelinePython()

vtkInSituPipelinePython::vtkInSituPipelinePython ( )

protected

◆ ~vtkInSituPipelinePython()

vtkInSituPipelinePython::~vtkInSituPipelinePython ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkInSituPipelinePython* vtkInSituPipelinePython::New ( )

static

◆ GetClassName()

virtual const char* vtkInSituPipelinePython::GetClassName ( )

virtual

Reimplemented from vtkInSituPipeline.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkInSituPipeline.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkInSituPipeline.

◆ SetFileName()

virtual void vtkInSituPipelinePython::SetFileName ( const char * )

virtual

Get/Set the path to either a .py file or a .zip file or a Python package directory.

◆ GetFileName()

virtual char* vtkInSituPipelinePython::GetFileName ( )

virtual

Get/Set the path to either a .py file or a .zip file or a Python package directory.

◆ SetArguments()

void vtkInSituPipelinePython::SetArguments ( const std::vector< std::string > & args )

Get/Set the arguments.

The vector is deep copied. Note, changing arguments after Initialize has no effect.

◆ GetArguments()

const std::vector<std::string>& vtkInSituPipelinePython::GetArguments ( ) const

inline

Get/Set the arguments.

The vector is deep copied. Note, changing arguments after Initialize has no effect.

Definition at line 44 of file vtkInSituPipelinePython.h.

◆ SetParameters()

void vtkInSituPipelinePython::SetParameters ( const std::vector< std::string > & params )

Get/Set the execute parameters.

The vector is deep copied.

◆ GetParameters()

const std::vector<std::string>& vtkInSituPipelinePython::GetParameters ( ) const

inline

Get/Set the execute parameters.

The vector is deep copied.

Definition at line 52 of file vtkInSituPipelinePython.h.

◆ Initialize()

bool vtkInSituPipelinePython::Initialize ( )

overridevirtual

vtkInSituPipeline API implementation.

Reimplemented from vtkInSituPipeline.

◆ Execute()

bool vtkInSituPipelinePython::Execute	(	int	,
		double
	)

overridevirtual

vtkInSituPipeline API implementation.

Implements vtkInSituPipeline.

◆ Results()

bool vtkInSituPipelinePython::Results ( )

overridevirtual

vtkInSituPipeline API implementation.

Reimplemented from vtkInSituPipeline.

◆ Finalize()

bool vtkInSituPipelinePython::Finalize ( )

overridevirtual

vtkInSituPipeline API implementation.

Reimplemented from vtkInSituPipeline.

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

/builds/gitlab-kitware-sciviz-ci/Clients/InSitu/vtkInSituPipelinePython.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

◆ vtkInSituPipelinePython()

◆ ~vtkInSituPipelinePython()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetFileName()

◆ GetFileName()

◆ SetArguments()

◆ GetArguments()

◆ SetParameters()

◆ GetParameters()

◆ Initialize()

◆ Execute()

◆ Results()

◆ Finalize()