baseclass for all proxy-objects that have counter parts on server as well as client processes. More...

#include <vtkSMRemoteObject.h>

Inheritance diagram for vtkSMRemoteObject:

[legend]

Collaboration diagram for vtkSMRemoteObject:

[legend]

Public Types
typedef vtkSMSessionObject	Superclass

Public Types inherited from vtkSMSessionObject
typedef vtkSMObject	Superclass

Public Types inherited from vtkSMObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetSession (vtkSMSession *) override
	Override the SetSession so if the object already have an ID we automatically register it to the associated session. More...

bool	HasGlobalID ()
	Allow the user to test if the RemoteObject has already a GlobalID without assigning a new one to it. More...

virtual const vtkSMMessage *	GetFullState ()
	This method return the full object state that can be used to create that object from scratch. More...

virtual void	EnableLocalPushOnly ()
	Allow to switch off any push of state change to the server for that particular object. More...

virtual void	DisableLocalPushOnly ()
	Enable the given remote object to communicate its state normally to the server location. More...

virtual bool	IsLocalPushOnly ()
	Let the session be aware that even if the Location is client only, the message should not be send to the server for a general broadcast. More...


virtual void	SetLocation (vtkTypeUInt32)
	Get/Set the location where the underlying VTK-objects are created. More...

virtual vtkTypeUInt32	GetLocation ()
	Get/Set the location where the underlying VTK-objects are created. More...


virtual vtkTypeUInt32	GetGlobalID ()
	Get the global unique id for this object. More...

const char *	GetGlobalIDAsString ()
	Get the global unique id for this object. More...


virtual void	PrototypeOn ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

virtual void	PrototypeOff ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

bool	IsPrototype ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

virtual void	SetPrototype (bool)
	Allow user to set the remote object to be discard for Undo/Redo action. More...


virtual void	LoadState (const vtkSMMessage msg, vtkSMProxyLocator locator)
	This method is used to initialise the object to the given state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalID set. More...

Public Member Functions inherited from vtkSMSessionObject
void	PrintSelf (ostream &os, vtkIndent indent) override

virtual vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Return the corresponding ProxyManager if any. More...

virtual vtkSMSession *	GetSession ()
	Get/Set the session on wihch this object exists. 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 vtkSMRemoteObject *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMSessionObject *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: 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
	vtkSMRemoteObject ()
	Default constructor. More...

	~vtkSMRemoteObject () override
	Destructor. More...

void	PushState (vtkSMMessage *msg)
	Subclasses can call this method to send a message to its state object on the server processes specified. More...

bool	PullState (vtkSMMessage *msg)
	Subclasses can call this method to pull the state from the state-object on the server processes specified. More...

void	SetGlobalID (vtkTypeUInt32 guid)
	Set the GlobalUniqueId. More...

vtkTypeUInt32	GetFilteredLocation ()

Protected Member Functions inherited from vtkSMSessionObject
	vtkSMSessionObject ()

	~vtkSMSessionObject () override

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

	~vtkSMObject () 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
vtkTypeUInt32	GlobalID

vtkTypeUInt32	Location

bool	Prototype

bool	ClientOnlyLocationFlag

Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session
	Identifies the session id to which this object is related. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkSMStateHelper

class	vtkSMStateLoader

Detailed Description

baseclass for all proxy-objects that have counter parts on server as well as client processes.

Abstract class involved in ServerManager class hierarchy that has a corresponding SIObject which can be local or remote.

Definition at line 25 of file vtkSMRemoteObject.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMSessionObject vtkSMRemoteObject::Superclass

Definition at line 32 of file vtkSMRemoteObject.h.

Constructor & Destructor Documentation

◆ vtkSMRemoteObject()

vtkSMRemoteObject::vtkSMRemoteObject ( )

protected

Default constructor.

◆ ~vtkSMRemoteObject()

vtkSMRemoteObject::~vtkSMRemoteObject ( )

overrideprotected

Destructor.

Member Function Documentation

◆ GetClassName()

virtual const char* vtkSMRemoteObject::GetClassName ( )

virtual

Reimplemented from vtkSMSessionObject.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMSessionObject.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMObject.

◆ SetLocation()

virtual void vtkSMRemoteObject::SetLocation ( vtkTypeUInt32 )

virtual

Get/Set the location where the underlying VTK-objects are created.

The value can be constructed by or-ing vtkSMSession::ServerFlags

Reimplemented in vtkSMProxy.

◆ GetLocation()

virtual vtkTypeUInt32 vtkSMRemoteObject::GetLocation ( )

virtual

Get/Set the location where the underlying VTK-objects are created.

The value can be constructed by or-ing vtkSMSession::ServerFlags

◆ SetSession()

void vtkSMRemoteObject::SetSession ( vtkSMSession * )

overridevirtual

Override the SetSession so if the object already have an ID we automatically register it to the associated session.

Reimplemented from vtkSMSessionObject.

◆ GetGlobalID()

virtual vtkTypeUInt32 vtkSMRemoteObject::GetGlobalID ( )

virtual

Get the global unique id for this object.

If none is set and the session is valid, a new global id will be assigned automatically.

Reimplemented in vtkSMSourceProxy, vtkSMRepresentationProxy, and vtkSMCollaborationManager.

◆ GetGlobalIDAsString()

const char* vtkSMRemoteObject::GetGlobalIDAsString ( )

Get the global unique id for this object.

If none is set and the session is valid, a new global id will be assigned automatically.

◆ HasGlobalID()

bool vtkSMRemoteObject::HasGlobalID ( )

Allow the user to test if the RemoteObject has already a GlobalID without assigning a new one to it.

◆ PrototypeOn()

virtual void vtkSMRemoteObject::PrototypeOn ( )

virtual

Allow user to set the remote object to be discard for Undo/Redo action.

By default, any remote object is Undoable.

Reimplemented in vtkSMProxy.

◆ PrototypeOff()

virtual void vtkSMRemoteObject::PrototypeOff ( )

virtual

Allow user to set the remote object to be discard for Undo/Redo action.

By default, any remote object is Undoable.

Reimplemented in vtkSMProxy.

◆ IsPrototype()

bool vtkSMRemoteObject::IsPrototype ( )

inline

Allow user to set the remote object to be discard for Undo/Redo action.

By default, any remote object is Undoable.

Definition at line 71 of file vtkSMRemoteObject.h.

◆ SetPrototype()

virtual void vtkSMRemoteObject::SetPrototype ( bool )

virtual

Allow user to set the remote object to be discard for Undo/Redo action.

By default, any remote object is Undoable.

Reimplemented in vtkSMProxy.

◆ GetFullState()

virtual const vtkSMMessage* vtkSMRemoteObject::GetFullState ( )

inlinevirtual

This method return the full object state that can be used to create that object from scratch.

This method will be used to fill the undo stack. If not overridden this will return nullptr.

Reimplemented in vtkSMProxy, vtkSMCollaborationManager, vtkSMProxySelectionModel, vtkSMLink, and vtkSMPipelineState.

Definition at line 81 of file vtkSMRemoteObject.h.

◆ LoadState()

virtual void vtkSMRemoteObject::LoadState	(	const vtkSMMessage *	msg,
		vtkSMProxyLocator *	locator
	)

inlinevirtual

This method is used to initialise the object to the given state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalID set.

This allow to split the load process in 2 step to prevent invalid state when property refere to a sub-proxy that does not exist yet.

Reimplemented in vtkSMProxy, vtkSMViewLayoutProxy, vtkSMProxyDefinitionManager, vtkSMCollaborationManager, vtkSMMultiplexerSourceProxy, vtkSMProxySelectionModel, vtkSMProxyLink, vtkSMPropertyLink, vtkSMLink, vtkSMCameraLink, vtkSMSelectionLink, vtkSMLiveInsituLinkProxy, vtkSMMultiServerSourceProxy, and vtkSMPipelineState.

Definition at line 91 of file vtkSMRemoteObject.h.

◆ EnableLocalPushOnly()

virtual void vtkSMRemoteObject::EnableLocalPushOnly ( )

virtual

Allow to switch off any push of state change to the server for that particular object.

This is used when we load a state based on a server notification. In that particular case, the server is already aware of that new state, so we keep those changes local.

Reimplemented in vtkSMProxy.

◆ DisableLocalPushOnly()

virtual void vtkSMRemoteObject::DisableLocalPushOnly ( )

virtual

Enable the given remote object to communicate its state normally to the server location.

Reimplemented in vtkSMProxy.

◆ IsLocalPushOnly()

virtual bool vtkSMRemoteObject::IsLocalPushOnly ( )

inlinevirtual

Let the session be aware that even if the Location is client only, the message should not be send to the server for a general broadcast.

Definition at line 117 of file vtkSMRemoteObject.h.

◆ PushState()

void vtkSMRemoteObject::PushState ( vtkSMMessage * msg )

protected

Subclasses can call this method to send a message to its state object on the server processes specified.

◆ PullState()

bool vtkSMRemoteObject::PullState ( vtkSMMessage * msg )

protected

Subclasses can call this method to pull the state from the state-object on the server processes specified.

Returns true on successful fetch. The message is updated with the fetched state.

◆ SetGlobalID()

void vtkSMRemoteObject::SetGlobalID ( vtkTypeUInt32 guid )

protected

Set the GlobalUniqueId.

◆ GetFilteredLocation()

vtkTypeUInt32 vtkSMRemoteObject::GetFilteredLocation ( )

protected

Friends And Related Function Documentation

◆ vtkSMStateHelper

friend class vtkSMStateHelper

friend

Definition at line 28 of file vtkSMRemoteObject.h.

◆ vtkSMStateLoader

friend class vtkSMStateLoader

friend

Definition at line 29 of file vtkSMRemoteObject.h.

Member Data Documentation

◆ GlobalID

vtkTypeUInt32 vtkSMRemoteObject::GlobalID

protected

Definition at line 153 of file vtkSMRemoteObject.h.

◆ Location

vtkTypeUInt32 vtkSMRemoteObject::Location

protected

Definition at line 157 of file vtkSMRemoteObject.h.

◆ Prototype

bool vtkSMRemoteObject::Prototype

protected

Definition at line 161 of file vtkSMRemoteObject.h.

◆ ClientOnlyLocationFlag

bool vtkSMRemoteObject::ClientOnlyLocationFlag

protected

Definition at line 164 of file vtkSMRemoteObject.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMRemoteObject()

◆ ~vtkSMRemoteObject()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetLocation()

◆ GetLocation()

◆ SetSession()

◆ GetGlobalID()

◆ GetGlobalIDAsString()

◆ HasGlobalID()

◆ PrototypeOn()

◆ PrototypeOff()

◆ IsPrototype()

◆ SetPrototype()

◆ GetFullState()

◆ LoadState()

◆ EnableLocalPushOnly()

◆ DisableLocalPushOnly()

◆ IsLocalPushOnly()

◆ PushState()

◆ PullState()

◆ SetGlobalID()

◆ GetFilteredLocation()

Friends And Related Function Documentation

◆ vtkSMStateHelper

◆ vtkSMStateLoader

Member Data Documentation

◆ GlobalID

◆ Location

◆ Prototype

◆ ClientOnlyLocationFlag