Utility class to load state from XML. More...

#include <vtkSMStateLoader.h>

Inheritance diagram for vtkSMStateLoader:

Collaboration diagram for vtkSMStateLoader:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	LoadState (vtkPVXMLElement *rootElement, bool keepOriginalId=false)

void	SetProxyLocator (vtkSMProxyLocator *loc)
virtual vtkSMProxyLocator *	GetProxyLocator ()
Static Public Member Functions
static vtkSMStateLoader *	New ()
static int	IsTypeOf (const char *type)
static vtkSMStateLoader *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMStateLoader ()
	~vtkSMStateLoader ()
virtual int	LoadStateInternal (vtkPVXMLElement *rootElement)
virtual void	CreatedNewProxy (vtkTypeUInt32 id, vtkSMProxy *proxy)
virtual int	HandleProxyCollection (vtkPVXMLElement *collectionElement)
virtual void	HandleCustomProxyDefinitions (vtkPVXMLElement *element)
int	HandleLinks (vtkPVXMLElement *linksElement)
virtual int	BuildProxyCollectionInformation (vtkPVXMLElement *)
int	HandleGlobalPropertiesManagers (vtkPVXMLElement *)
virtual vtkPVXMLElement *	LocateProxyElement (vtkTypeUInt32 id)
vtkPVXMLElement *	LocateProxyElementInternal (vtkPVXMLElement *root, vtkTypeUInt32 id)
virtual bool	VerifyXMLVersion (vtkPVXMLElement *rootElement)

virtual vtkSMProxy *	CreateProxy (const char xmlgroup, const char xmlname, const char *subProxyName=NULL)

virtual void	RegisterProxy (vtkTypeUInt32 id, vtkSMProxy *proxy)
virtual void	RegisterProxyInternal (const char group, const char name, vtkSMProxy *proxy)
Protected Attributes
vtkPVXMLElement *	ServerManagerStateElement
vtkSMProxyLocator *	ProxyLocator

Detailed Description

Utility class to load state from XML.

vtkSMStateLoader can load server manager state from a given vtkPVXMLElement. This element is usually populated by a vtkPVXMLParser.

See also:: vtkPVXMLParser vtkPVXMLElement

Definition at line 37 of file vtkSMStateLoader.h.

Constructor & Destructor Documentation

vtkSMStateLoader::vtkSMStateLoader ( ) [protected]

vtkSMStateLoader::~vtkSMStateLoader ( ) [protected]

Member Function Documentation

static vtkSMStateLoader* vtkSMStateLoader::New ( ) [static]

Reimplemented from vtkSMDeserializerXML.

virtual const char* vtkSMStateLoader::GetClassName ( ) [virtual]

Reimplemented from vtkSMDeserializerXML.

static int vtkSMStateLoader::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkSMDeserializerXML.

virtual int vtkSMStateLoader::IsA ( const char * type ) [virtual]

Reimplemented from vtkSMDeserializerXML.

static vtkSMStateLoader* vtkSMStateLoader::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkSMDeserializerXML.

void vtkSMStateLoader::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkSMDeserializerXML.

int vtkSMStateLoader::LoadState	(	vtkPVXMLElement *	rootElement,
		bool	keepOriginalId = `false`
	)

Load the state from the given root element.

void vtkSMStateLoader::SetProxyLocator ( vtkSMProxyLocator * loc )

Get/Set the proxy locator to use. Default is vtkSMProxyLocator will be used.

virtual vtkSMProxyLocator* vtkSMStateLoader::GetProxyLocator ( ) [virtual]

Get/Set the proxy locator to use. Default is vtkSMProxyLocator will be used.

virtual int vtkSMStateLoader::LoadStateInternal ( vtkPVXMLElement * rootElement ) [protected, virtual]

The rootElement must be the <ServerManagerState> xml element. If rootElement is not a <ServerManagerState> element, then we try to locate the first <ServerManagerState> nested element and load that. Load the state from the given root element.

virtual void vtkSMStateLoader::CreatedNewProxy	(	vtkTypeUInt32	id,
		vtkSMProxy *	proxy
	)		`[protected, virtual]`

Called after a new proxy is created. We register all created proxies.

Reimplemented from vtkSMDeserializerXML.

virtual vtkSMProxy* vtkSMStateLoader::CreateProxy	(	const char *	xmlgroup,
		const char *	xmlname,
		const char *	subProxyName = `NULL`
	)		`[protected, virtual]`

Overridden so that when new views are to be created, we create views suitable for the connection.

Reimplemented from vtkSMDeserializerXML.

virtual int vtkSMStateLoader::HandleProxyCollection ( vtkPVXMLElement * collectionElement ) [protected, virtual]

virtual void vtkSMStateLoader::HandleCustomProxyDefinitions ( vtkPVXMLElement * element ) [protected, virtual]

int vtkSMStateLoader::HandleLinks ( vtkPVXMLElement * linksElement ) [protected]

virtual int vtkSMStateLoader::BuildProxyCollectionInformation ( vtkPVXMLElement * ) [protected, virtual]

int vtkSMStateLoader::HandleGlobalPropertiesManagers ( vtkPVXMLElement * ) [protected]

Process the <GlobalPropertiesManagers> element.

virtual void vtkSMStateLoader::RegisterProxy	(	vtkTypeUInt32	id,
		vtkSMProxy *	proxy
	)		`[protected, virtual]`

This method scans through the internal data structure built during BuildProxyCollectionInformation() and registers the proxy. The DS keeps info about each proxy ID and the groups and names the proxy should be registered as (as indicated in the state file).

virtual void vtkSMStateLoader::RegisterProxyInternal	(	const char *	group,
		const char *	name,
		vtkSMProxy *	proxy
	)		`[protected, virtual]`

This method scans through the internal data structure built during BuildProxyCollectionInformation() and registers the proxy. The DS keeps info about each proxy ID and the groups and names the proxy should be registered as (as indicated in the state file).

virtual vtkPVXMLElement* vtkSMStateLoader::LocateProxyElement ( vtkTypeUInt32 id ) [protected, virtual]

Return the xml element for the state of the proxy with the given id. This is used by NewProxy() when the proxy with the given id is not located in the internal CreatedProxies map.

Reimplemented from vtkSMDeserializerXML.