vtkCPPythonScriptV2Helper Class Reference

an internal class encapsulating logic for Catalyst Python scripts. More...

#include <vtkCPPythonScriptV2Helper.h>

Inheritance diagram for vtkCPPythonScriptV2Helper:

Collaboration diagram for vtkCPPythonScriptV2Helper:

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
bool	PrepareFromScript (const std::string &fname)
	Prepares the Python package/module for import. More...
const std::string &	GetScriptFileName () const
	Returns the name of the script passed in to PrepareFromScript. More...
bool	IsImported () const
	Returns if the package/module has been imported. More...
bool	Import (const std::vector< std::string > &args={})
	Imports the module/package. More...
bool	CatalystInitialize ()
	Calls catalyst_initialize. More...
bool	CatalystFinalize ()
	Calls catalyst_finalize. More...
bool	CatalystExecute (int timestep, double time, const std::vector< std::string > &params={})
	Calls catalyst_execute. More...
bool	CatalystResults ()
	Calls catalyst_results. More...
bool	Import (vtkCPDataDescription *desc)
	There are overloads intended for vtkCPPythonScriptV2Pipeline i.e. More...
bool	CatalystInitialize (vtkCPDataDescription *desc)
	There are overloads intended for vtkCPPythonScriptV2Pipeline i.e. More...
bool	RequestDataDescription (vtkCPDataDescription *desc)
	There are overloads intended for vtkCPPythonScriptV2Pipeline i.e. More...
bool	CatalystExecute (vtkCPDataDescription *desc)
	There are overloads intended for vtkCPPythonScriptV2Pipeline i.e. 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 vtkCPPythonScriptV2Helper *	New ()
static int	IsTypeOf (const char *type)
static vtkCPPythonScriptV2Helper *	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
	vtkCPPythonScriptV2Helper ()
	~vtkCPPythonScriptV2Helper () override
bool	IsActivated (int timestep, double time)
bool	IsLiveActivated ()
void	DoLive (int, double)
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 &)
static vtkCPPythonScriptV2Helper *	GetActiveInstance ()
	Internal methods. More...
void	RegisterExtractor (vtkSMProxy *extractor)
	Internal methods. More...
void	RegisterView (vtkSMProxy *view)
	Internal methods. More...
void	SetOptions (vtkSMProxy *catalystOptions)
	Internal methods. More...
virtual vtkSMProxy *	GetOptions ()
	Internal methods. More...
vtkCPDataDescription *	GetDataDescription () const
	Internal methods. More...
vtkSMProxy *	GetTrivialProducer (const char *inputname)
	Internal methods. More...
vtkStringList *	GetArgumentsAsStringList () const
	Internal methods. More...
vtkStringList *	GetParametersAsStringList () const
	Internal methods. More...

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

an internal class encapsulating logic for Catalyst Python scripts.

This class is an internal helper to share code between vtkInSituPipelinePython and vtkCPPythonScriptV2Pipeline.

Definition at line 23 of file vtkCPPythonScriptV2Helper.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkCPPythonScriptV2Helper::Superclass

Definition at line 27 of file vtkCPPythonScriptV2Helper.h.

Constructor & Destructor Documentation

vtkCPPythonScriptV2Helper()

vtkCPPythonScriptV2Helper::vtkCPPythonScriptV2Helper ( )

protected

~vtkCPPythonScriptV2Helper()

vtkCPPythonScriptV2Helper::~vtkCPPythonScriptV2Helper ( )

overrideprotected

Member Function Documentation

New()

static vtkCPPythonScriptV2Helper* vtkCPPythonScriptV2Helper::New ( )

static

GetClassName()

virtual const char* vtkCPPythonScriptV2Helper::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkObjectBase.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

PrepareFromScript()

bool vtkCPPythonScriptV2Helper::PrepareFromScript

(

const std::string &

fname

)

Prepares the Python package/module for import.

This doesn't actually import it yet. Returns false if the prep failed for some reason.

GetScriptFileName()

const std::string& vtkCPPythonScriptV2Helper::GetScriptFileName

(

)

const

Returns the name of the script passed in to PrepareFromScript.

IsImported()

bool vtkCPPythonScriptV2Helper::IsImported

(

)

const

Returns if the package/module has been imported.

Import() [1/2]

bool vtkCPPythonScriptV2Helper::Import

(

const std::vector< std::string > &

args = {}

)

Imports the module/package.

This overload is used by vtkInSituPipelinePython which in turn is used in ParaView-Catalyst, the ParaView-based implementation of the Catalyst In Situ API.

Returns true on success.

CatalystInitialize() [1/2]

bool vtkCPPythonScriptV2Helper::CatalystInitialize

(

)

Calls catalyst_initialize.

CatalystFinalize()

bool vtkCPPythonScriptV2Helper::CatalystFinalize

(

)

Calls catalyst_finalize.

CatalystExecute() [1/2]

bool vtkCPPythonScriptV2Helper::CatalystExecute	(	int	timestep,
		double	time,
		const std::vector< std::string > &	params = {}
	)

Calls catalyst_execute.

CatalystResults()

bool vtkCPPythonScriptV2Helper::CatalystResults

(

)

Calls catalyst_results.

Import() [2/2]

bool vtkCPPythonScriptV2Helper::Import

(

vtkCPDataDescription *

desc

)

There are overloads intended for vtkCPPythonScriptV2Pipeline i.e.

legacy Catalyst adaptors that don't use Conduit.

CatalystInitialize() [2/2]

bool vtkCPPythonScriptV2Helper::CatalystInitialize

(

vtkCPDataDescription *

desc

)

There are overloads intended for vtkCPPythonScriptV2Pipeline i.e.

legacy Catalyst adaptors that don't use Conduit.

RequestDataDescription()

bool vtkCPPythonScriptV2Helper::RequestDataDescription

(

vtkCPDataDescription *

desc

)

There are overloads intended for vtkCPPythonScriptV2Pipeline i.e.

legacy Catalyst adaptors that don't use Conduit.

CatalystExecute() [2/2]

bool vtkCPPythonScriptV2Helper::CatalystExecute

(

vtkCPDataDescription *

desc

)

There are overloads intended for vtkCPPythonScriptV2Pipeline i.e.

legacy Catalyst adaptors that don't use Conduit.

GetActiveInstance()

static vtkCPPythonScriptV2Helper* vtkCPPythonScriptV2Helper::GetActiveInstance ( )

static

Internal methods.

These are called by Python modules internal to ParaView and may change without notice. Should not be considered as part of ParaView API.

RegisterExtractor()

void vtkCPPythonScriptV2Helper::RegisterExtractor

(

vtkSMProxy *

extractor

)

Internal methods.

These are called by Python modules internal to ParaView and may change without notice. Should not be considered as part of ParaView API.

RegisterView()

void vtkCPPythonScriptV2Helper::RegisterView

(

vtkSMProxy *

view

)

Internal methods.

These are called by Python modules internal to ParaView and may change without notice. Should not be considered as part of ParaView API.

SetOptions()

void vtkCPPythonScriptV2Helper::SetOptions

(

vtkSMProxy *

catalystOptions

)

Internal methods.

These are called by Python modules internal to ParaView and may change without notice. Should not be considered as part of ParaView API.

GetOptions()

virtual vtkSMProxy* vtkCPPythonScriptV2Helper::GetOptions ( )

virtual

Internal methods.

These are called by Python modules internal to ParaView and may change without notice. Should not be considered as part of ParaView API.

GetDataDescription()

vtkCPDataDescription* vtkCPPythonScriptV2Helper::GetDataDescription ( ) const

inline

Internal methods.

These are called by Python modules internal to ParaView and may change without notice. Should not be considered as part of ParaView API.

Definition at line 97 of file vtkCPPythonScriptV2Helper.h.

GetTrivialProducer()

vtkSMProxy* vtkCPPythonScriptV2Helper::GetTrivialProducer

(

const char *

inputname

)

Internal methods.

These are called by Python modules internal to ParaView and may change without notice. Should not be considered as part of ParaView API.

GetArgumentsAsStringList()

vtkStringList* vtkCPPythonScriptV2Helper::GetArgumentsAsStringList

(

)

const

Internal methods.

These are called by Python modules internal to ParaView and may change without notice. Should not be considered as part of ParaView API.

GetParametersAsStringList()

vtkStringList* vtkCPPythonScriptV2Helper::GetParametersAsStringList

(

)

const

Internal methods.

These are called by Python modules internal to ParaView and may change without notice. Should not be considered as part of ParaView API.

IsActivated()

bool vtkCPPythonScriptV2Helper::IsActivated ( int  timestep, double  time  )

protected

IsLiveActivated()

bool vtkCPPythonScriptV2Helper::IsLiveActivated ( )

protected

DoLive()

void vtkCPPythonScriptV2Helper::DoLive ( int  , double    )

protected

---

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

• /builds/gitlab-kitware-sciviz-ci/Clients/PythonCatalyst/vtkCPPythonScriptV2Helper.h