deserializes proxies from their XML states. More...

#include <vtkSMDeserializerXML.h>

Inheritance diagram for vtkSMDeserializerXML:

[legend]

Collaboration diagram for vtkSMDeserializerXML:

[legend]

Public Types
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 vtkSMDeserializer
void	SetSession (vtkSMSession *session)
	Convenience method for setting the SessionProxyManager. More...

vtkSMSession *	GetSession ()
	Provides access to the session. More...

vtkSMSessionProxyManager *	GetSessionProxyManager ()
	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)

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 vtkSMDeserializerXML *	New ()

static int	IsTypeOf (const char *type)

static vtkSMDeserializerXML *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMDeserializer
static int	IsTypeOf (const char *type)

static vtkSMDeserializer *	SafeDownCast (vtkObject *o)

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
	vtkSMDeserializerXML ()

	~vtkSMDeserializerXML () override

vtkSMProxy *	NewProxy (vtkTypeUInt32 id, vtkSMProxyLocator *locator) override
	Create a new proxy with the `id` if possible. More...

virtual vtkPVXMLElement *	LocateProxyElement (vtkTypeUInt32 id)
	Locate the XML for the proxy with the given id. More...

virtual int	LoadProxyState (vtkPVXMLElement element, vtkSMProxy , vtkSMProxyLocator *locator)
	TEMPORARY. More...

vtkSMProxy *	CreateProxy (const char xmlgroup, const char xmlname, const char *subProxyName=nullptr) override
	Create a new proxy of the given group and name. More...

virtual void	CreatedNewProxy (vtkTypeUInt32 id, vtkSMProxy *proxy)
	Called after a new proxy has been created. 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 &)

Friends
class	vtkSMProxyLocator

Additional Inherited Members
Protected Attributes inherited from vtkSMDeserializer
vtkWeakPointer< vtkSMSessionProxyManager >	SessionProxyManager

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

deserializes proxies from their XML states.

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

Definition at line 22 of file vtkSMDeserializerXML.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMDeserializer vtkSMDeserializerXML::Superclass

Definition at line 26 of file vtkSMDeserializerXML.h.

Constructor & Destructor Documentation

◆ vtkSMDeserializerXML()

vtkSMDeserializerXML::vtkSMDeserializerXML ( )

protected

◆ ~vtkSMDeserializerXML()

vtkSMDeserializerXML::~vtkSMDeserializerXML ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMDeserializerXML* vtkSMDeserializerXML::New ( )

static

◆ GetClassName()

virtual const char* vtkSMDeserializerXML::GetClassName ( )

virtual

Reimplemented from vtkSMDeserializer.

Reimplemented in vtkSMStateLoader, vtkSMCompoundProxyDefinitionLoader, vtkSMDeserializerXMLCache, and vtkSMInsituStateLoader.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMDeserializer.

Reimplemented in vtkSMStateLoader, vtkSMCompoundProxyDefinitionLoader, vtkSMDeserializerXMLCache, and vtkSMInsituStateLoader.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMDeserializer.

Reimplemented in vtkSMStateLoader, and vtkSMDeserializerXMLCache.

◆ NewProxy()

vtkSMProxy* vtkSMDeserializerXML::NewProxy	(	vtkTypeUInt32	id,
		vtkSMProxyLocator *	locator
	)

overrideprotectedvirtual

Create a new proxy with the id if possible.

Implements vtkSMDeserializer.

◆ LocateProxyElement()

virtual vtkPVXMLElement* vtkSMDeserializerXML::LocateProxyElement ( vtkTypeUInt32 id )

protectedvirtual

Locate the XML for the proxy with the given id.

Reimplemented in vtkSMStateLoader, vtkSMDeserializerXMLCache, and vtkSMCompoundProxyDefinitionLoader.

◆ LoadProxyState()

virtual int vtkSMDeserializerXML::LoadProxyState	(	vtkPVXMLElement *	element,
		vtkSMProxy *	,
		vtkSMProxyLocator *	locator
	)

protectedvirtual

TEMPORARY.

Used to load the state on the proxy. This is only for the sake of the lookmark state loader until we get the chance to clean it up. DON'T override this method.

◆ CreateProxy()

vtkSMProxy* vtkSMDeserializerXML::CreateProxy	(	const char *	xmlgroup,
		const char *	xmlname,
		const char *	subProxyName = `nullptr`
	)

overrideprotectedvirtual

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 from vtkSMDeserializer.

Reimplemented in vtkSMStateLoader.

◆ CreatedNewProxy()

virtual void vtkSMDeserializerXML::CreatedNewProxy	(	vtkTypeUInt32	id,
		vtkSMProxy *	proxy
	)

protectedvirtual

Called after a new proxy has been created.

Gives the subclasses an opportunity to perform certain tasks such as registering proxies etc. Default implementation is empty.

Reimplemented in vtkSMStateLoader.

Friends And Related Function Documentation

◆ vtkSMProxyLocator

friend class vtkSMProxyLocator

friend

Definition at line 34 of file vtkSMDeserializerXML.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMDeserializerXML()

◆ ~vtkSMDeserializerXML()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ NewProxy()

◆ LocateProxyElement()

◆ LoadProxyState()

◆ CreateProxy()

◆ CreatedNewProxy()

Friends And Related Function Documentation

◆ vtkSMProxyLocator