Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkSMDeserializer Class Referenceabstract

deserializes proxies from their states. More...

#include <vtkSMDeserializer.h>

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

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
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 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

 vtkSMDeserializer ()
 
 ~vtkSMDeserializer () override
 
virtual vtkSMProxyNewProxy (vtkTypeUInt32 id, vtkSMProxyLocator *locator)=0
 Create a new proxy with the id if possible. More...
 
virtual vtkSMProxyCreateProxy (const char *xmlgroup, const char *xmlname, const char *subProxyName=nullptr)
 Create a new proxy of the given group and name. More...
 
- 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< vtkSMSessionProxyManagerSessionProxyManager
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkSMProxyLocator
 

Detailed Description

deserializes proxies from their states.

vtkSMDeserializer is used to deserialize proxies from their XML/Protobuf/? states. This is the base class of deserialization classes that load XMLs/Protobuf/? to restore servermanager state (or part thereof).

Definition at line 25 of file vtkSMDeserializer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 28 of file vtkSMDeserializer.h.

Constructor & Destructor Documentation

◆ vtkSMDeserializer()

vtkSMDeserializer::vtkSMDeserializer ( )
protected

◆ ~vtkSMDeserializer()

vtkSMDeserializer::~vtkSMDeserializer ( )
overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkSMDeserializer::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ SetSession()

void vtkSMDeserializer::SetSession ( vtkSMSession session)

Convenience method for setting the SessionProxyManager.

This is equivalent to calling vtkSMDeserializer::SetSessionProxyManager(session->GetSessionProxyManager()).

◆ GetSessionProxyManager()

vtkSMSessionProxyManager* vtkSMDeserializer::GetSessionProxyManager ( )

Get/Set the proxy manager on which this deserializer is expected to operate.

◆ SetSessionProxyManager()

void vtkSMDeserializer::SetSessionProxyManager ( vtkSMSessionProxyManager )

Get/Set the proxy manager on which this deserializer is expected to operate.

◆ GetSession()

vtkSMSession* vtkSMDeserializer::GetSession ( )

Provides access to the session.

This is same as calling this->GetSessionProxyManager()->GetSession() (with nullptr checks).

◆ NewProxy()

virtual vtkSMProxy* vtkSMDeserializer::NewProxy ( vtkTypeUInt32  id,
vtkSMProxyLocator locator 
)
protectedpure virtual

Create a new proxy with the id if possible.

Implemented in vtkSMDeserializerProtobuf, vtkSMDeserializerXML, and vtkSMInsituStateLoader.

◆ CreateProxy()

virtual vtkSMProxy* vtkSMDeserializer::CreateProxy ( const char *  xmlgroup,
const char *  xmlname,
const char *  subProxyName = nullptr 
)
protectedvirtual

Create a new proxy of the given group and name.

Default implementation simply asks the proxy manager to create a new proxy of the requested type.

Reimplemented in vtkSMStateLoader, and vtkSMDeserializerXML.

Friends And Related Function Documentation

◆ vtkSMProxyLocator

friend class vtkSMProxyLocator
friend

Definition at line 58 of file vtkSMDeserializer.h.

Member Data Documentation

◆ SessionProxyManager

vtkWeakPointer<vtkSMSessionProxyManager> vtkSMDeserializer::SessionProxyManager
protected

Definition at line 72 of file vtkSMDeserializer.h.


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