vtkSISourceProxy for all VTKPythonAlgorithmBase-based algorithms. More...

#include <vtkSIPythonSourceProxy.h>

Inheritance diagram for vtkSIPythonSourceProxy:

Collaboration diagram for vtkSIPythonSourceProxy:

[legend]

Public Types
typedef vtkSISourceProxy	Superclass

Public Types inherited from vtkSISourceProxy
typedef vtkSIProxy	Superclass

Public Types inherited from vtkSIProxy
typedef vtkSIObject	Superclass

Public Types inherited from vtkSIObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	Push (vtkSMMessage *) override
	Push a new state to the underneath implementation. More...

void	Pull (vtkSMMessage *) override
	Pull the current state of the underneath implementation. More...

void	RecreateVTKObjects () override
	Overridden to update the output ports. More...

void	Initialize (vtkPVSessionCore *session) override
	Initializes the instance. More...

Public Member Functions inherited from vtkSISourceProxy
virtual vtkAlgorithmOutput *	GetOutputPort (int port)
	Returns the vtkAlgorithmOutput for an output port, if valid. More...

void	UpdatePipelineInformation () override
	Triggers UpdateInformation() on vtkObject if possible. More...

virtual void	UpdatePipeline (int port, double time, bool doTime)
	Triggers UpdatePipeline(). More...

virtual void	SetupSelectionProxy (int port, vtkSIProxy *extractSelection)
	setups extract selection proxies. More...

virtual void	SetDisablePipelineExecution (bool value)
	Allow to shut down pipeline execution. More...

Public Member Functions inherited from vtkSIProxy
void	AboutToDelete () override
	This method is called before the deletion of the SIObject. More...

vtkSIProperty *	GetSIProperty (const char *name)
	Provides access to the property helper. More...

bool	IsNullProxy ()
	Return true if that Proxy is supposed to have NO vtk class, which means its a NullProxy. More...

virtual bool	ExtendDefinition (const char *xml)
	Counter part to vtkSMSelfGeneratingSourceProxy::ExtendDefinition(). More...

const char *	GetLogNameOrDefault ()
	A helper that makes up an default name if none is provided. More...

vtkObjectBase *	GetVTKObject ()
	Returns access to the VTKObject pointer, if any. More...

void	SetVTKObject (vtkObjectBase *)
	Returns access to the VTKObject pointer, if any. More...

virtual char *	GetVTKClassName ()
	Returns the VTKClassName. More...

virtual char *	GetXMLName ()
	Assigned by the XML parser. More...

virtual char *	GetXMLGroup ()
	Assigned by the XML parser. More...

virtual void	AddInput (int input_port, vtkAlgorithmOutput connection, const char method)
	These methods are called to add/remove input connections by vtkSIInputProperty. More...

virtual void	CleanInputs (const char *method)
	These methods are called to add/remove input connections by vtkSIInputProperty. More...

Public Member Functions inherited from vtkSIObject
vtkClientServerInterpreter *	GetInterpreter ()
	Provides access to the Interpreter. More...

vtkSIObject *	GetSIObject (vtkTypeUInt32 globalid) const
	Convenience method to obtain a vtkSIObject subclass given its global id. More...

vtkObject *	GetRemoteObject (vtkTypeUInt32 globalid)
	Convenience method to obtain a vtkObject subclass given its global id. More...

virtual void	SetGlobalID (vtkTypeUInt32)
	Get/Set the global id for this object. More...

virtual vtkTypeUInt32	GetGlobalID ()
	Get/Set the global id for this object. 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 vtkSIPythonSourceProxy *	New ()

static int	IsTypeOf (const char *type)

static vtkSIPythonSourceProxy *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSISourceProxy *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSIProxy *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSIObject *	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
	vtkSIPythonSourceProxy ()

	~vtkSIPythonSourceProxy () override

vtkObjectBase *	NewVTKObject (const char *className) override
	Overridden to use the Python interpreter to instantiate Python classes. More...

void	DeleteVTKObjects () override
	Overridden to release any Python objects created. More...

Protected Member Functions inherited from vtkSISourceProxy
	vtkSISourceProxy ()

	~vtkSISourceProxy () override

bool	CreateVTKObjects () override
	Overridden to setup the output ports and pipelines for the output ports. More...

bool	ReadXMLAttributes (vtkPVXMLElement *element) override
	Read xml-attributes. More...

void	OnCreateVTKObjects () override
	Called after CreateVTKObjects(). More...

virtual bool	CreateOutputPorts ()
	Create the output ports and add post filters for each output port. More...

virtual void	SetExecutiveName (const char *)

void	MarkStartEvent ()
	Callbacks to add start/end events to the timer log. More...

void	MarkEndEvent ()
	Callbacks to add start/end events to the timer log. More...

Protected Member Functions inherited from vtkSIProxy
	vtkSIProxy ()

	~vtkSIProxy () override

vtkSIProxy *	GetSubSIProxy (const char *name)
	Returns the subproxy helper for the subproxy with the given name, if any. More...

vtkSIProxyDefinitionManager *	GetProxyDefinitionManager ()
	Provides access to the vtkSIProxyDefinitionManager held by the session. More...

bool	InitializeAndCreateVTKObjects (vtkSMMessage *message)
	Called by vtkSIProxy::Push() to ensure that the vtkSIProxy has been initialized. More...

void	AddSIProperty (const char name, vtkSIProperty )
	Adds a vtkSMProperty's server-implementation. More...

virtual void	SetVTKClassName (const char *)

virtual void	SetXMLGroup (const char *)

virtual void	SetXMLName (const char *)

virtual void	SetXMLSubProxyName (const char *)

virtual void	SetPostPush (const char *)

virtual void	SetPostCreation (const char *)

virtual char *	GetLogName ()

void	SetLogName (const char *name)

unsigned int	GetNumberOfSubSIProxys ()
	API to iterate over subproxy helpers. More...

vtkSIProxy *	GetSubSIProxy (unsigned int cc)
	API to iterate over subproxy helpers. More...

virtual bool	ReadXMLProperty (vtkPVXMLElement *property_element)
	Parses the XML to create property/subproxy helpers. More...

virtual bool	ReadXMLSubProxy (vtkPVXMLElement *subproxy_element)
	Parses the XML to create property/subproxy helpers. More...

Protected Member Functions inherited from vtkSIObject
	vtkSIObject ()

	~vtkSIObject () 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 vtkSISourceProxy
char *	ExecutiveName

bool	DisablePipelineExecution

Protected Attributes inherited from vtkSIProxy
char *	VTKClassName

char *	XMLGroup

char *	XMLName

char *	XMLSubProxyName

char *	PostPush

char *	PostCreation

int	NumberOfInputPorts

vtkSmartPointer< vtkObjectBase >	VTKObject

bool	ObjectsCreated

Protected Attributes inherited from vtkSIObject
vtkWeakPointer< vtkClientServerInterpreter >	Interpreter

vtkWeakPointer< vtkPVSessionCore >	SessionCore

vtkSMMessage *	LastPushedMessage

vtkTypeUInt32	GlobalID

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

vtkSISourceProxy for all VTKPythonAlgorithmBase-based algorithms.

vtkSIPythonSourceProxy makes is possible to work with a VTKPythonAlgorithmBase-based Python class in ParaView. By handling the push/pull APIs to forward the calls to the Python object, we can make such Python algorithms behave like regular C++-based algorithm subclasses.

Definition at line 23 of file vtkSIPythonSourceProxy.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSISourceProxy vtkSIPythonSourceProxy::Superclass

Definition at line 27 of file vtkSIPythonSourceProxy.h.

Constructor & Destructor Documentation

◆ vtkSIPythonSourceProxy()

vtkSIPythonSourceProxy::vtkSIPythonSourceProxy ( )

protected

◆ ~vtkSIPythonSourceProxy()

vtkSIPythonSourceProxy::~vtkSIPythonSourceProxy ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSIPythonSourceProxy* vtkSIPythonSourceProxy::New ( )

static

◆ GetClassName()

virtual const char* vtkSIPythonSourceProxy::GetClassName ( )

virtual

Reimplemented from vtkSISourceProxy.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSISourceProxy.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSISourceProxy.

◆ Push()

void vtkSIPythonSourceProxy::Push ( vtkSMMessage * msg )

overridevirtual

Push a new state to the underneath implementation.

Reimplemented from vtkSIProxy.

◆ Pull()

void vtkSIPythonSourceProxy::Pull ( vtkSMMessage * msg )

overridevirtual

Pull the current state of the underneath implementation.

Reimplemented from vtkSIProxy.

◆ RecreateVTKObjects()

void vtkSIPythonSourceProxy::RecreateVTKObjects ( )

overridevirtual

Overridden to update the output ports.

Reimplemented from vtkSISourceProxy.

◆ Initialize()

void vtkSIPythonSourceProxy::Initialize ( vtkPVSessionCore * session )

overridevirtual

Initializes the instance.

Session is the session to which this instance belongs to. During initialization, the SIObject basically obtains ivars for necessary components.

Reimplemented from vtkSIObject.

◆ NewVTKObject()

vtkObjectBase* vtkSIPythonSourceProxy::NewVTKObject ( const char * className )

overrideprotectedvirtual

Overridden to use the Python interpreter to instantiate Python classes.

Reimplemented from vtkSIProxy.

◆ DeleteVTKObjects()

void vtkSIPythonSourceProxy::DeleteVTKObjects ( )

overrideprotectedvirtual

Overridden to release any Python objects created.

Reimplemented from vtkSIProxy.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManagerPython/vtkSIPythonSourceProxy.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

◆ vtkSIPythonSourceProxy()

◆ ~vtkSIPythonSourceProxy()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Push()

◆ Pull()

◆ RecreateVTKObjects()

◆ Initialize()

◆ NewVTKObject()

◆ DeleteVTKObjects()