ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkSMStateVersionControllerBase Class Reference

#include <vtkSMStateVersionControllerBase.h>

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

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual bool Process (vtkPVXMLElement *root)=0
void Select (vtkPVXMLElement *root, const char *childName, const char *childAttrs[], bool(*funcPtr)(vtkPVXMLElement *, void *), void *callData)
void SelectAndSetAttributes (vtkPVXMLElement *root, const char *childName, const char *childAttrs[], const char *newAttrs[])

Static Public Member Functions

static int IsTypeOf (const char *type)
static
vtkSMStateVersionControllerBase
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSMStateVersionControllerBase ()
 ~vtkSMStateVersionControllerBase ()
void ReadVersion (vtkPVXMLElement *, int version[3])
int GetMajor (int version[3])
int GetMinor (int version[3])
int GetPatch (int version[3])
void SelectAndRemove (vtkPVXMLElement *root, const char *childName, const char *childAttrs[])
void UpdateVersion (int version[3], int minversion[3])

Detailed Description

vtkSMStateVersionControllerBase is used to convert the state XML from any previously supported versions to the current version. This class merely defines the API.

See also:
vtkSMStateVersionController

Definition at line 31 of file vtkSMStateVersionControllerBase.h.


Constructor & Destructor Documentation

vtkSMStateVersionControllerBase::vtkSMStateVersionControllerBase ( ) [protected]
vtkSMStateVersionControllerBase::~vtkSMStateVersionControllerBase ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkSMObject.

Reimplemented in vtkSMStateVersionController.

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

Reimplemented from vtkSMObject.

Reimplemented in vtkSMStateVersionController.

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

Reimplemented from vtkSMObject.

Reimplemented in vtkSMStateVersionController.

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

Reimplemented from vtkSMObject.

Reimplemented in vtkSMStateVersionController.

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

Reimplemented from vtkSMObject.

Reimplemented in vtkSMStateVersionController.

virtual bool vtkSMStateVersionControllerBase::Process ( vtkPVXMLElement root) [pure virtual]

Called before a state is loaded. The argument must be the root element for the state being loaded. eg. for server manager state, it will point to <ServerManagerState> element. Returns false if the conversion failed, else true.

Implemented in vtkSMStateVersionController.

void vtkSMStateVersionControllerBase::Select ( vtkPVXMLElement root,
const char *  childName,
const char *  childAttrs[],
bool(*)(vtkPVXMLElement *, void *)  funcPtr,
void *  callData 
)

Select all 1-level deep children of root with name=childName and with attributes specified in the childAttrs (if non-null) and invoke the callback for all such matches.

void vtkSMStateVersionControllerBase::SelectAndSetAttributes ( vtkPVXMLElement root,
const char *  childName,
const char *  childAttrs[],
const char *  newAttrs[] 
)

Select all 1-level deep children of the root with name=childName and with attributes specified in the childAttrs (if non-null) and set the newAttrs on it. Both childAttrs and newAttrs must be terminated by 0.

void vtkSMStateVersionControllerBase::ReadVersion ( vtkPVXMLElement ,
int  version[3] 
) [protected]
int vtkSMStateVersionControllerBase::GetMajor ( int  version[3]) [inline, protected]

Definition at line 73 of file vtkSMStateVersionControllerBase.h.

int vtkSMStateVersionControllerBase::GetMinor ( int  version[3]) [inline, protected]

Definition at line 76 of file vtkSMStateVersionControllerBase.h.

int vtkSMStateVersionControllerBase::GetPatch ( int  version[3]) [inline, protected]

Definition at line 79 of file vtkSMStateVersionControllerBase.h.

void vtkSMStateVersionControllerBase::UpdateVersion ( int  version[3],
int  minversion[3] 
) [inline, protected]

Updates version to be atleast as big as minversion.

Definition at line 84 of file vtkSMStateVersionControllerBase.h.

void vtkSMStateVersionControllerBase::SelectAndRemove ( vtkPVXMLElement root,
const char *  childName,
const char *  childAttrs[] 
) [protected]

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