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

#include <vtkSMInsituStateLoader.h>

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

Public Types

typedef vtkSMStateLoader Superclass
 
- Public Types inherited from vtkSMStateLoader
typedef vtkSMDeserializerXML Superclass
 
- Public Types inherited from vtkSMDeserializerXML
typedef vtkSMDeserializer Superclass
 
- Public Types inherited from vtkSMDeserializer
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkSMStateLoader
void PrintSelf (ostream &os, vtkIndent indent) override
 
int LoadState (vtkPVXMLElement *rootElement, bool keepOriginalId=false)
 Load the state from the given root element. More...
 
void SetProxyLocator (vtkSMProxyLocator *loc)
 Get/Set the proxy locator to use. More...
 
virtual vtkSMProxyLocatorGetProxyLocator ()
 Get/Set the proxy locator to use. More...
 
virtual void SetKeepIdMapping (int)
 Allow the loader to keep the mapping between the id from the loaded state to the current proxy attributed id. More...
 
virtual int GetKeepIdMapping ()
 Allow the loader to keep the mapping between the id from the loaded state to the current proxy attributed id. More...
 
virtual void KeepIdMappingOn ()
 Allow the loader to keep the mapping between the id from the loaded state to the current proxy attributed id. More...
 
virtual void KeepIdMappingOff ()
 Allow the loader to keep the mapping between the id from the loaded state to the current proxy attributed id. More...
 
vtkTypeUInt32 * GetMappingArray (int &size)
 Return an array of ids. More...
 
- Public Member Functions inherited from vtkSMDeserializer
void SetSession (vtkSMSession *session)
 Convenience method for setting the SessionProxyManager. More...
 
vtkSMSessionGetSession ()
 Provides access to the session. More...
 
vtkSMSessionProxyManagerGetSessionProxyManager ()
 Get/Set the proxy manager on which this deserializer is expected to operate. More...
 
void SetSessionProxyManager (vtkSMSessionProxyManager *)
 Get/Set the proxy manager on which this deserializer is expected to operate. 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 vtkSMInsituStateLoaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMInsituStateLoaderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMStateLoader
static vtkSMStateLoaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMStateLoaderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDeserializerXML
static vtkSMDeserializerXMLNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMDeserializerXMLSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDeserializer
static int IsTypeOf (const char *type)
 
static vtkSMDeserializerSafeDownCast (vtkObject *o)
 
- 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

 vtkSMInsituStateLoader ()
 
 ~vtkSMInsituStateLoader () override
 
vtkSMProxyNewProxy (vtkTypeUInt32 id, vtkSMProxyLocator *locator) override
 Overridden to try to reuse existing proxies as much as possible. More...
 
- Protected Member Functions inherited from vtkSMStateLoader
virtual int LoadStateInternal (vtkPVXMLElement *rootElement)
 The rootElement must be the <ServerManagerState/> xml element. More...
 
void CreatedNewProxy (vtkTypeUInt32 id, vtkSMProxy *proxy) override
 Called after a new proxy is created. More...
 
vtkSMProxyCreateProxy (const char *xmlgroup, const char *xmlname, const char *subProxyName=nullptr) override
 Overridden so that when new views are to be created, we create views suitable for the connection. More...
 
virtual int HandleProxyCollection (vtkPVXMLElement *collectionElement)
 
virtual void HandleCustomProxyDefinitions (vtkPVXMLElement *element)
 
int HandleLinks (vtkPVXMLElement *linksElement)
 
virtual int BuildProxyCollectionInformation (vtkPVXMLElement *)
 
virtual bool UpdateRegistrationInfo (std::string &group, std::string &name, vtkSMProxy *proxy)
 Update a proxy's registration group and name before it gets registered. More...
 
vtkPVXMLElementLocateProxyElement (vtkTypeUInt32 id) override
 Return the xml element for the state of the proxy with the given id. More...
 
vtkPVXMLElementLocateProxyElementInternal (vtkPVXMLElement *root, vtkTypeUInt32 id)
 Used by LocateProxyElement(). More...
 
virtual bool VerifyXMLVersion (vtkPVXMLElement *rootElement)
 Checks the root element for version. More...
 
vtkSMProxyLocateExistingProxyUsingRegistrationName (vtkTypeUInt32 id)
 Returns the first proxy already registered using any of the registration (group, name) assigned to the proxy with the given id in the state file. More...
 
virtual void RegisterProxy (vtkTypeUInt32 id, vtkSMProxy *proxy)
 This method scans through the internal data structure built during BuildProxyCollectionInformation() and registers the proxy. More...
 
virtual void RegisterProxyInternal (const char *group, const char *name, vtkSMProxy *proxy)
 This method scans through the internal data structure built during BuildProxyCollectionInformation() and registers the proxy. More...
 
 vtkSMStateLoader ()
 Return an array of ids. More...
 
 ~vtkSMStateLoader () override
 Return an array of ids. More...
 
- Protected Member Functions inherited from vtkSMDeserializerXML
 vtkSMDeserializerXML ()
 
 ~vtkSMDeserializerXML () override
 
vtkSMProxyNewProxy (vtkTypeUInt32 id, vtkSMProxyLocator *locator) override
 Create a new proxy with the id if possible. More...
 
virtual int LoadProxyState (vtkPVXMLElement *element, vtkSMProxy *, vtkSMProxyLocator *locator)
 TEMPORARY. More...
 
- Protected Member Functions inherited from vtkSMDeserializer
 vtkSMDeserializer ()
 
 ~vtkSMDeserializer () 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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMStateLoader
vtkPVXMLElementServerManagerStateElement
 
vtkSMProxyLocatorProxyLocator
 
int KeepIdMapping
 
- Protected Attributes inherited from vtkSMDeserializer
vtkWeakPointer< vtkSMSessionProxyManagerSessionProxyManager
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Definition at line 27 of file vtkSMInsituStateLoader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 31 of file vtkSMInsituStateLoader.h.

Constructor & Destructor Documentation

◆ vtkSMInsituStateLoader()

vtkSMInsituStateLoader::vtkSMInsituStateLoader ( )
protected

◆ ~vtkSMInsituStateLoader()

vtkSMInsituStateLoader::~vtkSMInsituStateLoader ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMInsituStateLoader* vtkSMInsituStateLoader::New ( )
static

◆ GetClassName()

virtual const char* vtkSMInsituStateLoader::GetClassName ( )
virtual

Reimplemented from vtkSMStateLoader.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMStateLoader.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkObject.

◆ NewProxy()

vtkSMProxy* vtkSMInsituStateLoader::NewProxy ( vtkTypeUInt32  id,
vtkSMProxyLocator locator 
)
overrideprotectedvirtual

Overridden to try to reuse existing proxies as much as possible.

Implements vtkSMDeserializer.


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