Stores code and option for python modules. More...

#include <vtkPVPythonModule.h>

Inheritance diagram for vtkPVPythonModule:

Collaboration diagram for vtkPVPythonModule:

[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 char *	GetSource ()
	Set/get the full Python source for this module. More...

virtual void	SetSource (const char *)
	Set/get the full Python source for this module. More...


virtual char *	GetFullName ()
	Set/get the full name for this module (e.g. More...

virtual void	SetFullName (const char *)
	Set/get the full name for this module (e.g. More...


virtual int	GetIsPackage ()
	Set/get a flag indicating whether this module is actually a package (which can have submodules). More...

virtual void	SetIsPackage (int)
	Set/get a flag indicating whether this module is actually a package (which can have submodules). More...

virtual void	IsPackageOn ()
	Set/get a flag indicating whether this module is actually a package (which can have submodules). More...

virtual void	IsPackageOff ()
	Set/get a flag indicating whether this module is actually a package (which can have submodules). 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 vtkPVPythonModule *	SafeDownCast (vtkObject *o)

static vtkPVPythonModule *	New ()

static void	RegisterModule (vtkPVPythonModule *module)
	Register the Python module. More...

static vtkPVPythonModule *	GetModule (const char *fullname)
	Return the registered Python module with the given full module name. More...

static int	HasModule (const char *fullname)
	Returns 1 if a Python module with the given full name has been registered, 0 otherwise. More...

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
	vtkPVPythonModule ()

	~vtkPVPythonModule () 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 &)

Protected Attributes
char *	Source

char *	FullName

int	IsPackage

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Stores code and option for python modules.

vtkPVPythonModule is a simple class that stores some Python source code that makes up a Python module as well as some state variables about the module (such as its name).

Definition at line 24 of file vtkPVPythonModule.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVPythonModule::Superclass

Definition at line 27 of file vtkPVPythonModule.h.

Constructor & Destructor Documentation

◆ vtkPVPythonModule()

vtkPVPythonModule::vtkPVPythonModule ( )

protected

◆ ~vtkPVPythonModule()

vtkPVPythonModule::~vtkPVPythonModule ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPVPythonModule::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ New()

static vtkPVPythonModule* vtkPVPythonModule::New ( )

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ GetSource()

virtual char* vtkPVPythonModule::GetSource ( )

virtual

Set/get the full Python source for this module.

◆ SetSource()

virtual void vtkPVPythonModule::SetSource ( const char * )

virtual

Set/get the full Python source for this module.

◆ GetFullName()

virtual char* vtkPVPythonModule::GetFullName ( )

virtual

Set/get the full name for this module (e.g.

package.subpackage.module).

◆ SetFullName()

virtual void vtkPVPythonModule::SetFullName ( const char * )

virtual

Set/get the full name for this module (e.g.

package.subpackage.module).

◆ GetIsPackage()

virtual int vtkPVPythonModule::GetIsPackage ( )

virtual

Set/get a flag indicating whether this module is actually a package (which can have submodules).

◆ SetIsPackage()

virtual void vtkPVPythonModule::SetIsPackage ( int )

virtual

Set/get a flag indicating whether this module is actually a package (which can have submodules).

◆ IsPackageOn()

virtual void vtkPVPythonModule::IsPackageOn ( )

virtual

Set/get a flag indicating whether this module is actually a package (which can have submodules).

◆ IsPackageOff()

virtual void vtkPVPythonModule::IsPackageOff ( )

virtual

Set/get a flag indicating whether this module is actually a package (which can have submodules).

◆ RegisterModule()

static void vtkPVPythonModule::RegisterModule ( vtkPVPythonModule * module )

static

Register the Python module.

Once registered, the module can be retrieved with GetModule and HaveModule. Python interpreters can query these global methods in a custom import mechanism.

◆ GetModule()

static vtkPVPythonModule* vtkPVPythonModule::GetModule ( const char * fullname )

static

Return the registered Python module with the given full module name.

If no such module has been registered, this returns nullptr.

◆ HasModule()

static int vtkPVPythonModule::HasModule ( const char * fullname )

inlinestatic

Returns 1 if a Python module with the given full name has been registered, 0 otherwise.

Definition at line 74 of file vtkPVPythonModule.h.

Member Data Documentation

◆ Source

char* vtkPVPythonModule::Source

protected

Definition at line 83 of file vtkPVPythonModule.h.

◆ FullName

char* vtkPVPythonModule::FullName

protected

Definition at line 84 of file vtkPVPythonModule.h.

◆ IsPackage

int vtkPVPythonModule::IsPackage

protected

Definition at line 85 of file vtkPVPythonModule.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkPVPythonModule.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVPythonModule()

◆ ~vtkPVPythonModule()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ New()

◆ PrintSelf()

◆ GetSource()

◆ SetSource()

◆ GetFullName()

◆ SetFullName()

◆ GetIsPackage()

◆ SetIsPackage()

◆ IsPackageOn()

◆ IsPackageOff()

◆ RegisterModule()

◆ GetModule()

◆ HasModule()

Member Data Documentation

◆ Source

◆ FullName

◆ IsPackage