iso::serialize::Serializable Class Reference

abstract serializable object class More...

#include <iso_serialize_serializable.h>

Inherited by iso::serialize::SerializeManager.

Inheritance diagram for iso::serialize::Serializable:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual SerializeData serialize (const base::String &pSerialName=sClassName) const =0
 create SerializeData object
virtual ~Serializable ()
 destructor

Static Public Member Functions

static SerializabledeSerialize (const SerializeData &pSerializeData) throw (SerializeException)
 create object from SerializeData

Static Public Attributes

static const base::String sClassName
 class name

Detailed Description

abstract serializable object class

object class

abstract base class for all objects which are serializable

in order for an object to be serializable is must have the following properties: a static classname : that's the name by which the class is identified within the xml document (if not overwritten) a method to create a serialize_data object which contains all the necessary information to build a class instance from it a constructor which accepts a serialize_data object in order to create a class instance a static method to create a class instance from a serialize_data object every serializable class needs to register itself automatically in the serialize_manager: i.e. const String Event::sClassName = SerializeManager::get().registerSerializable<Event>("Event");

Created by Daniel Bisig on 8/20/06. Copyright 2006 Daniel Bisig All rights reserved.


Constructor & Destructor Documentation

Serializable::~Serializable (  )  [virtual]

destructor


Member Function Documentation

virtual SerializeData iso::serialize::Serializable::serialize ( const base::String &  pSerialName = sClassName  )  const [pure virtual]

create SerializeData object

Parameters:
pSerialName overwrites default serial name
Returns:
SerializeData

Implemented in iso::serialize::SerializeManager.

static Serializable* iso::serialize::Serializable::deSerialize ( const SerializeData pSerializeData  )  throw (SerializeException) [inline, static]

create object from SerializeData

Parameters:
pSerializeData SerializeData
Returns:
Serializable
Exceptions:
SerializeException incompatible SerializeData

Reimplemented in iso::serialize::SerializeManager.


Member Data Documentation

const base::String Serializable::sClassName [static]

class name

Reimplemented in iso::serialize::SerializeManager.


The documentation for this class was generated from the following files:
Generated on Fri Feb 25 14:07:19 2011 for iso_serialize by  doxygen 1.5.1