Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMServerStateLocator Class Reference

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

#include <vtkSMServerStateLocator.h>

Inheritance diagram for vtkSMServerStateLocator:
Inheritance graph
[legend]
Collaboration diagram for vtkSMServerStateLocator:
Collaboration graph
[legend]

Public Types

typedef vtkSMStateLocator Superclass
 
- Public Types inherited from vtkSMStateLocator
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
 
bool FindState (vtkTypeUInt32 globalID, vtkSMMessage *stateToFill, bool useParent) override
 Fill the provided State message with the state found inside the current locator or one of its parent. More...
 
vtkSMSessionGetSession ()
 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...
 
void SetSession (vtkSMSession *session)
 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 vtkSMStateLocator
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 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 vtkSMStateLocatorGetParentLocator ()
 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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkSMServerStateLocatorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMServerStateLocatorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMStateLocator
static vtkSMStateLocatorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMStateLocatorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (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 vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMServerStateLocator ()
 
 ~vtkSMServerStateLocator () override
 
- Protected Member Functions inherited from vtkSMStateLocator
 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

vtkWeakPointer< vtkSMSessionSession
 
- Protected Attributes inherited from vtkSMStateLocator
vtkSMStateLocatorParentLocator
 
vtkWeakPointer< vtkSMSessionSession
 
vtkWeakPointer< vtkUndoStackUndoStack
 
- 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 from the DataServer.

Retrieve a given state from the server.

Definition at line 21 of file vtkSMServerStateLocator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 25 of file vtkSMServerStateLocator.h.

Constructor & Destructor Documentation

◆ vtkSMServerStateLocator()

vtkSMServerStateLocator::vtkSMServerStateLocator ( )
protected

◆ ~vtkSMServerStateLocator()

vtkSMServerStateLocator::~vtkSMServerStateLocator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMServerStateLocator* vtkSMServerStateLocator::New ( )
static

◆ GetClassName()

virtual const char* vtkSMServerStateLocator::GetClassName ( )
virtual

Reimplemented from vtkSMStateLocator.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMStateLocator.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSMServerStateLocator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkSMObject.

◆ GetSession()

vtkSMSession* vtkSMServerStateLocator::GetSession ( )

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.

◆ SetSession()

void vtkSMServerStateLocator::SetSession ( vtkSMSession session)

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.

◆ FindState()

bool vtkSMServerStateLocator::FindState ( vtkTypeUInt32  globalID,
vtkSMMessage stateToFill,
bool  useParent 
)
overridevirtual

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. In that case useParent is not used and is set to false.

Reimplemented from vtkSMStateLocator.

Member Data Documentation

◆ Session

vtkWeakPointer<vtkSMSession> vtkSMServerStateLocator::Session
protected

Definition at line 49 of file vtkSMServerStateLocator.h.


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