Class used to retreive a given message state based on its GlobalID. More...
#include <vtkSMStateLocator.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | InitGarbageCollector (vtkSMSession *, vtkUndoStack *) |
| virtual void | RegisterState (const vtkSMMessage *state) |
| virtual void | UnRegisterState (vtkTypeUInt32 globalID, bool force) |
| virtual void | UnRegisterAllStates (bool force) |
| virtual bool | IsStateLocal (vtkTypeUInt32 globalID) |
| virtual bool | IsStateAvailable (vtkTypeUInt32 globalID) |
| virtual void | RegisterFullState (vtkSMProxy *proxy) |
| virtual void | SetParentLocator (vtkSMStateLocator *) |
| virtual vtkSMStateLocator * | GetParentLocator () |
| virtual bool | FindState (vtkTypeUInt32 globalID, vtkSMMessage *stateToFill, bool useParent=true) |
Static Public Member Functions | |
| static vtkSMStateLocator * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkSMStateLocator * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkSMStateLocator () | |
| ~vtkSMStateLocator () | |
Protected Attributes | |
| vtkSMStateLocator * | ParentLocator |
| vtkWeakPointer< vtkSMSession > | Session |
| vtkWeakPointer< vtkUndoStack > | UndoStack |
Detailed Description
Class used to retreive a given message state based on its GlobalID.
vtkSMStateLocator allow a hierarchical way of finding a message state.
Definition at line 33 of file vtkSMStateLocator.h.
Constructor & Destructor Documentation
| vtkSMStateLocator::vtkSMStateLocator | ( | ) | [protected] |
| vtkSMStateLocator::~vtkSMStateLocator | ( | ) | [protected] |
Member Function Documentation
| static vtkSMStateLocator* vtkSMStateLocator::New | ( | ) | [static] |
Reimplemented from vtkSMObject.
Reimplemented in vtkSMServerStateLocator.
| virtual const char* vtkSMStateLocator::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSMObject.
Reimplemented in vtkSMServerStateLocator.
| static int vtkSMStateLocator::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkSMObject.
Reimplemented in vtkSMServerStateLocator.
| virtual int vtkSMStateLocator::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkSMObject.
Reimplemented in vtkSMServerStateLocator.
| static vtkSMStateLocator* vtkSMStateLocator::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSMObject.
Reimplemented in vtkSMServerStateLocator.
| void vtkSMStateLocator::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSMObject.
Reimplemented in vtkSMServerStateLocator.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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
| virtual bool vtkSMStateLocator::IsStateAvailable | ( | vtkTypeUInt32 | globalID | ) | [virtual] |
Return true if the given state do exist in the locator hierachy
| 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
vtkSMStateLocator* vtkSMStateLocator::ParentLocator [protected] |
Definition at line 90 of file vtkSMStateLocator.h.
vtkWeakPointer<vtkSMSession> vtkSMStateLocator::Session [protected] |
Reimplemented in vtkSMServerStateLocator.
Definition at line 91 of file vtkSMStateLocator.h.
vtkWeakPointer<vtkUndoStack> vtkSMStateLocator::UndoStack [protected] |
Definition at line 92 of file vtkSMStateLocator.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMStateLocator.h
