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

#include <vtkSMRemoteObject.h>

Inheritance diagram for vtkSMRemoteObject:

Collaboration diagram for vtkSMRemoteObject:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetSession (vtkSMSession *)
bool	HasGlobalID ()
virtual void	EnableLocalPushOnly ()
virtual void	DisableLocalPushOnly ()
virtual bool	IsLocalPushOnly ()

virtual void	SetLocation (vtkTypeUInt32)
virtual vtkTypeUInt32	GetLocation ()

virtual vtkTypeUInt32	GetGlobalID ()
const char *	GetGlobalIDAsString ()

virtual void	PrototypeOn ()
virtual void	PrototypeOff ()
bool	IsPrototype ()
virtual void	SetPrototype (bool)

virtual const vtkSMMessage *	GetFullState ()

virtual void	LoadState (const vtkSMMessage msg, vtkSMProxyLocator locator)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkSMRemoteObject *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMRemoteObject ()
virtual	~vtkSMRemoteObject ()
void	PushState (vtkSMMessage *msg)
bool	PullState (vtkSMMessage *msg)
void	SetGlobalID (vtkTypeUInt32 guid)
vtkTypeUInt32	GetFilteredLocation ()
Protected Attributes
vtkTypeUInt32	GlobalID
vtkTypeUInt32	Location
bool	Prototype
bool	ClientOnlyLocationFlag
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 35 of file vtkSMRemoteObject.h.

Constructor & Destructor Documentation

vtkSMRemoteObject::vtkSMRemoteObject ( ) [protected]

Default constructor.

virtual vtkSMRemoteObject::~vtkSMRemoteObject ( ) [protected, virtual]

Destructor.

Member Function Documentation

virtual const char* vtkSMRemoteObject::GetClassName ( ) [virtual]

Reimplemented from vtkSMSessionObject.

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

Reimplemented from vtkSMSessionObject.

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

Reimplemented from vtkSMSessionObject.

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

Reimplemented from vtkSMSessionObject.

void vtkSMRemoteObject::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkSMSessionObject.

virtual void vtkSMRemoteObject::SetLocation ( vtkTypeUInt32 ) [virtual]

Get/Set the location where the underlying VTK-objects are created. The value can be contructed by or-ing vtkSMSession::ServerFlags

Reimplemented in vtkSMProxy.

virtual vtkTypeUInt32 vtkSMRemoteObject::GetLocation ( ) [virtual]

Get/Set the location where the underlying VTK-objects are created. The value can be contructed by or-ing vtkSMSession::ServerFlags

virtual void vtkSMRemoteObject::SetSession ( vtkSMSession * ) [virtual]

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

Reimplemented from vtkSMSessionObject.

Reimplemented in vtkSMCollaborationManager, vtkSMProxyDefinitionManager, and vtkSMProxySelectionModel.

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, and vtkSMCollaborationManager.

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.

bool vtkSMRemoteObject::HasGlobalID ( )

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

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.

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.

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.

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.

virtual const vtkSMMessage* vtkSMRemoteObject::GetFullState ( ) [inline, virtual]

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 overriden this will return NULL.

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

Definition at line 81 of file vtkSMRemoteObject.h.

virtual void vtkSMRemoteObject::LoadState	(	const vtkSMMessage *	msg,
		vtkSMProxyLocator *	locator
	)		`[inline, virtual]`

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, vtkSMProxySelectionModel, vtkSMCollaborationManager, vtkSMPropertyLink, vtkSMLink, vtkSMProxyLink, vtkSMCameraLink, vtkSMMultiServerSourceProxy, and vtkSMPipelineState.

Definition at line 92 of file vtkSMRemoteObject.h.

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.

virtual void vtkSMRemoteObject::DisableLocalPushOnly ( ) [virtual]

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

Reimplemented in vtkSMProxy.

virtual bool vtkSMRemoteObject::IsLocalPushOnly ( ) [inline, virtual]

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 111 of file vtkSMRemoteObject.h.

void vtkSMRemoteObject::PushState ( vtkSMMessage * msg ) [protected]

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

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.

void vtkSMRemoteObject::SetGlobalID ( vtkTypeUInt32 guid ) [protected]

Set the GlobalUniqueId

vtkTypeUInt32 vtkSMRemoteObject::GetFilteredLocation ( ) [protected]

Friends And Related Function Documentation

friend class vtkSMStateHelper [friend]

Definition at line 38 of file vtkSMRemoteObject.h.

friend class vtkSMStateLoader [friend]

Reimplemented in vtkSMLink.

Definition at line 39 of file vtkSMRemoteObject.h.

Member Data Documentation

vtkTypeUInt32 vtkSMRemoteObject::GlobalID [protected]

Definition at line 137 of file vtkSMRemoteObject.h.

vtkTypeUInt32 vtkSMRemoteObject::Location [protected]

Definition at line 141 of file vtkSMRemoteObject.h.

bool vtkSMRemoteObject::Prototype [protected]

Definition at line 145 of file vtkSMRemoteObject.h.

bool vtkSMRemoteObject::ClientOnlyLocationFlag [protected]

Definition at line 148 of file vtkSMRemoteObject.h.

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

dox/ParaViewCore/ServerManager/vtkSMRemoteObject.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation