Class used to retrieve a given message state based on its GlobalID. More...

#include <vtkSMStateLocator.h>

Inheritance diagram for vtkSMStateLocator:

[legend]

Collaboration diagram for vtkSMStateLocator:

[legend]

Public Types
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	InitGarbageCollector (vtkSMSession , vtkUndoStack )
	By initializing the garabage collector the stored state get removed once their is no more chance for them to be reused inside the session. More...

virtual bool	FindState (vtkTypeUInt32 globalID, vtkSMMessage *stateToFill, bool useParent=true)
	Fill the provided State message with the state found inside the current locator or one of its parent. More...

virtual void	RegisterState (const vtkSMMessage *state)
	Register the given state in the current locator. More...

virtual void	UnRegisterState (vtkTypeUInt32 globalID, bool force)
	Remove a state for a given proxy inside the local locator. More...

virtual void	UnRegisterAllStates (bool force)
	Remove all the registered states if force is true, it will also remove it from its hierarchical parents. More...

virtual bool	IsStateLocal (vtkTypeUInt32 globalID)
	Return true if the given state can be found locally whitout the help of on the hierarchical parent. More...

virtual bool	IsStateAvailable (vtkTypeUInt32 globalID)
	Return true if the given state do exist in the locator hierarchy. More...

virtual void	RegisterFullState (vtkSMProxy *proxy)
	Register the given proxy state as well as all its sub-proxy state so if that proxy need to be renew all its sub-proxy will be renew in the exact same state. More...


virtual void	SetParentLocator (vtkSMStateLocator *)
	Set/Get a parent locator to search which is used as a backup location to search from if a given state was not found locally. More...

virtual vtkSMStateLocator *	GetParentLocator ()
	Set/Get a parent locator to search which is used as a backup location to search from if a given state was not found locally. 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 vtkSMStateLocator *	New ()

static int	IsTypeOf (const char *type)

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

	~vtkSMStateLocator () 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
vtkSMStateLocator *	ParentLocator

vtkWeakPointer< vtkSMSession >	Session

vtkWeakPointer< vtkUndoStack >	UndoStack

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Class used to retrieve a given message state based on its GlobalID.

vtkSMStateLocator allow a hierarchical way of finding a message state.

Definition at line 23 of file vtkSMStateLocator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkSMStateLocator::Superclass

Definition at line 27 of file vtkSMStateLocator.h.

Constructor & Destructor Documentation

◆ vtkSMStateLocator()

vtkSMStateLocator::vtkSMStateLocator ( )

protected

◆ ~vtkSMStateLocator()

vtkSMStateLocator::~vtkSMStateLocator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMStateLocator* vtkSMStateLocator::New ( )

static

◆ GetClassName()

virtual const char* vtkSMStateLocator::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMServerStateLocator.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMServerStateLocator.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMObject.

◆ SetParentLocator()

virtual void vtkSMStateLocator::SetParentLocator ( vtkSMStateLocator * )

virtual

Set/Get a parent locator to search which is used as a backup location to search from if a given state was not found locally.

◆ GetParentLocator()

virtual vtkSMStateLocator* vtkSMStateLocator::GetParentLocator ( )

virtual

Set/Get a parent locator to search which is used as a backup location to search from if a given state was not found locally.

◆ InitGarbageCollector()

void vtkSMStateLocator::InitGarbageCollector	(	vtkSMSession *	,
		vtkUndoStack *
	)

By initializing the garabage collector the stored state get removed once their is no more chance for them to be reused inside the session.

◆ FindState()

virtual bool vtkSMStateLocator::FindState	(	vtkTypeUInt32	globalID,
		vtkSMMessage *	stateToFill,
		bool	useParent = `true`
	)

virtual

Fill the provided State message with the state found inside the current locator or one of its parent.

The method return true if the state was successfully filled. The "useParent" flag allow to disable parent lookup but by default it is set to true.

Reimplemented in vtkSMServerStateLocator.

◆ RegisterState()

virtual void vtkSMStateLocator::RegisterState ( const vtkSMMessage * state )

virtual

Register the given state in the current locator.

If a previous state was available, the new one will replace it.

◆ UnRegisterState()

virtual void vtkSMStateLocator::UnRegisterState	(	vtkTypeUInt32	globalID,
		bool	force
	)

virtual

Remove a state for a given proxy inside the local locator.

if force is true, it will also remove it from its hierarchical parents.

◆ UnRegisterAllStates()

virtual void vtkSMStateLocator::UnRegisterAllStates ( bool force )

virtual

Remove all the registered states if force is true, it will also remove it from its hierarchical parents.

◆ IsStateLocal()

virtual bool vtkSMStateLocator::IsStateLocal ( vtkTypeUInt32 globalID )

virtual

Return true if the given state can be found locally whitout the help of on the hierarchical parent.

◆ IsStateAvailable()

virtual bool vtkSMStateLocator::IsStateAvailable ( vtkTypeUInt32 globalID )

virtual

Return true if the given state do exist in the locator hierarchy.

◆ RegisterFullState()

virtual void vtkSMStateLocator::RegisterFullState ( vtkSMProxy * proxy )

virtual

Register the given proxy state as well as all its sub-proxy state so if that proxy need to be renew all its sub-proxy will be renew in the exact same state.

Member Data Documentation

◆ ParentLocator

vtkSMStateLocator* vtkSMStateLocator::ParentLocator

protected

Definition at line 94 of file vtkSMStateLocator.h.

◆ Session

vtkWeakPointer<vtkSMSession> vtkSMStateLocator::Session

protected

Definition at line 95 of file vtkSMStateLocator.h.

◆ UndoStack

vtkWeakPointer<vtkUndoStack> vtkSMStateLocator::UndoStack

protected

Definition at line 96 of file vtkSMStateLocator.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMStateLocator()

◆ ~vtkSMStateLocator()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetParentLocator()

◆ GetParentLocator()

◆ InitGarbageCollector()

◆ FindState()

◆ RegisterState()

◆ UnRegisterState()

◆ UnRegisterAllStates()

◆ IsStateLocal()

◆ IsStateAvailable()

◆ RegisterFullState()

Member Data Documentation

◆ ParentLocator

◆ Session

◆ UndoStack