Public Member Functions | Protected Member Functions

vtkKWESerializationHelper Class Reference

Superclass for serialization helpers. More...

#include <vtkKWESerializationHelper.h>

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

List of all members.

Public Member Functions

 vtkTypeRevisionMacro (vtkKWESerializationHelper, vtkObject)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void RegisterWithHelperMap ()=0
virtual void UnRegisterWithHelperMap ()=0
virtual const char * GetSerializationType (vtkObject *object)=0
virtual int Serialize (vtkObject *object, vtkKWESerializer *serializer)=0

Protected Member Functions

 vtkKWESerializationHelper ()
 ~vtkKWESerializationHelper ()

Detailed Description

Superclass for serialization helpers.

Abstract class for serialization of vtkObjects with the vtkKWEXMLArchiveWriter and vtkKWEXMLArchiveReader. Subclasses must implement RegisterWithHelperMap (which registers each class type supported by the helper with the vtkKWESerializationHelperMap), GetSerializationType (returns the "type" to set as the attribute for the element), and Serialize (which does the actual serialization) and UnRegisterWithHelperMap().

See also:
vtkKWESerializationHelperMap

Definition at line 42 of file vtkKWESerializationHelper.h.


Constructor & Destructor Documentation

vtkKWESerializationHelper::vtkKWESerializationHelper (  )  [inline, protected]

Definition at line 66 of file vtkKWESerializationHelper.h.

vtkKWESerializationHelper::~vtkKWESerializationHelper (  )  [inline, protected]

Definition at line 67 of file vtkKWESerializationHelper.h.


Member Function Documentation

vtkKWESerializationHelper::vtkTypeRevisionMacro ( vtkKWESerializationHelper  ,
vtkObject   
)
void vtkKWESerializationHelper::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]
virtual void vtkKWESerializationHelper::RegisterWithHelperMap (  )  [pure virtual]

This member registers ALL the classes supported by this helper with the vtkKWESerializationHelperMap, which manages all the helpers. Should be called after construction unless you only want to enable support for a subset (in which case it must be done "manually" by calling vtkKWESerializationHelperMap::RegisterHelperForClass()

Implemented in vtkKWECommonSerializationHelper, and vtkKWERenderingSerializationHelper.

virtual void vtkKWESerializationHelper::UnRegisterWithHelperMap (  )  [pure virtual]

Unregister the helper (remove each class type/helper pair) with the vtkKWESerializationHelperMap

Implemented in vtkKWECommonSerializationHelper, and vtkKWERenderingSerializationHelper.

virtual const char* vtkKWESerializationHelper::GetSerializationType ( vtkObject object  )  [pure virtual]

Get the value for the "type" attribute of the specfied object type

Implemented in vtkKWECommonSerializationHelper, and vtkKWERenderingSerializationHelper.

virtual int vtkKWESerializationHelper::Serialize ( vtkObject object,
vtkKWESerializer serializer 
) [pure virtual]

Serialize the input object. Returns 1 if successful.

Implemented in vtkKWECommonSerializationHelper, and vtkKWERenderingSerializationHelper.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines