Object that is managed by vtkPVSessionCore which wrap concrete class such as the vtk ones. More...

#include <vtkSIObject.h>

Inheritance diagram for vtkSIObject:

[legend]

Collaboration diagram for vtkSIObject:

[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 void	AboutToDelete ()
	This method is called before the deletion of the SIObject. More...

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

virtual void	Push (vtkSMMessage *msg)
	Push a new state to the underneath implementation The provided implementation just store the message and return it at the Pull one. More...

virtual void	Pull (vtkSMMessage *msg)
	Pull the current state of the underneath implementation The provided implementation update the given message with the one that has been previously pushed. More...

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 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
	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 &)

Protected Attributes
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

Object that is managed by vtkPVSessionCore which wrap concrete class such as the vtk ones.

Definition at line 21 of file vtkSIObject.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkSIObject::Superclass

Definition at line 25 of file vtkSIObject.h.

Constructor & Destructor Documentation

◆ vtkSIObject()

vtkSIObject::vtkSIObject ( )

protected

◆ ~vtkSIObject()

vtkSIObject::~vtkSIObject ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSIObject* vtkSIObject::New ( )

static

◆ GetClassName()

virtual const char* vtkSIObject::GetClassName ( )

virtual

Reimplemented in vtkSIProxyDefinitionManager, vtkSISourceProxy, vtkSIPythonSourceProxy, vtkSIProxy, vtkSIDirectoryProxy, vtkSIMetaReaderProxy, vtkSICompoundSourceProxy, vtkSIImageTextureProxy, vtkSIMultiplexerSourceProxy, vtkSIUnstructuredGridVolumeRepresentationProxy, vtkSIImporterProxy, vtkSICollaborationManager, vtkSIWriterProxy, and vtkSIPVRepresentationProxy.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

Reimplemented in vtkSIProxyDefinitionManager, vtkSISourceProxy, vtkSIPythonSourceProxy, vtkSIProxy, vtkSIDirectoryProxy, vtkSIMetaReaderProxy, vtkSICompoundSourceProxy, vtkSIImageTextureProxy, vtkSIMultiplexerSourceProxy, vtkSIUnstructuredGridVolumeRepresentationProxy, vtkSIImporterProxy, vtkSICollaborationManager, vtkSIWriterProxy, and vtkSIPVRepresentationProxy.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkSIProxyDefinitionManager, vtkSISourceProxy, vtkSIPythonSourceProxy, vtkSIProxy, vtkSIImageTextureProxy, vtkSIUnstructuredGridVolumeRepresentationProxy, vtkSIWriterProxy, and vtkSIPVRepresentationProxy.

◆ AboutToDelete()

virtual void vtkSIObject::AboutToDelete ( )

inlinevirtual

This method is called before the deletion of the SIObject.

Basically this is used to remove all dependency with other SIObject so after a first pass on all SIObject with a AboutToDelete() we can simply delete the remaining SIObjects.

Reimplemented in vtkSIProxy, and vtkSIPVRepresentationProxy.

Definition at line 34 of file vtkSIObject.h.

◆ Initialize()

virtual void vtkSIObject::Initialize ( vtkPVSessionCore * session )

virtual

Initializes the instance.

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

Reimplemented in vtkSIPythonSourceProxy.

◆ Push()

virtual void vtkSIObject::Push ( vtkSMMessage * msg )

virtual

Push a new state to the underneath implementation The provided implementation just store the message and return it at the Pull one.

Reimplemented in vtkSIProxyDefinitionManager, vtkSIProxy, vtkSIPythonSourceProxy, and vtkSICollaborationManager.

◆ Pull()

virtual void vtkSIObject::Pull ( vtkSMMessage * msg )

virtual

Pull the current state of the underneath implementation The provided implementation update the given message with the one that has been previously pushed.

Reimplemented in vtkSIProxyDefinitionManager, vtkSIProxy, vtkSICollaborationManager, vtkSIDirectoryProxy, and vtkSIPythonSourceProxy.

◆ GetInterpreter()

vtkClientServerInterpreter* vtkSIObject::GetInterpreter ( )

Provides access to the Interpreter.

◆ GetSIObject()

vtkSIObject* vtkSIObject::GetSIObject ( vtkTypeUInt32 globalid ) const

Convenience method to obtain a vtkSIObject subclass given its global id.

◆ GetRemoteObject()

vtkObject* vtkSIObject::GetRemoteObject ( vtkTypeUInt32 globalid )

Convenience method to obtain a vtkObject subclass given its global id.

◆ SetGlobalID()

virtual void vtkSIObject::SetGlobalID ( vtkTypeUInt32 )

virtual

Get/Set the global id for this object.

◆ GetGlobalID()

virtual vtkTypeUInt32 vtkSIObject::GetGlobalID ( )

virtual

Get/Set the global id for this object.

Member Data Documentation

◆ Interpreter

vtkWeakPointer<vtkClientServerInterpreter> vtkSIObject::Interpreter

protected

Definition at line 85 of file vtkSIObject.h.

◆ SessionCore

vtkWeakPointer<vtkPVSessionCore> vtkSIObject::SessionCore

protected

Definition at line 86 of file vtkSIObject.h.

◆ LastPushedMessage

vtkSMMessage* vtkSIObject::LastPushedMessage

protected

Definition at line 88 of file vtkSIObject.h.

◆ GlobalID

vtkTypeUInt32 vtkSIObject::GlobalID

protected

Definition at line 90 of file vtkSIObject.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSIObject.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSIObject()

◆ ~vtkSIObject()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ AboutToDelete()

◆ Initialize()

◆ Push()

◆ Pull()

◆ GetInterpreter()

◆ GetSIObject()

◆ GetRemoteObject()

◆ SetGlobalID()

◆ GetGlobalID()

Member Data Documentation

◆ Interpreter

◆ SessionCore

◆ LastPushedMessage

◆ GlobalID