mi::ISerializable Class Reference

All serializable objects have to be derived from this interface. More...

Inheritance diagram for mi::ISerializable:

Public Member Functions
virtual base::Uuid	get_class_id () const =0
	Returns the class ID of the object. More...
virtual void	serialize (ISerializer *serializer) const =0
	Serializes the object to the given serializer. More...
virtual void	deserialize (IDeserializer *deserializer)=0
	Deserializes the object from the given deserializer. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x7a70f2fb, 0x1b27, 0x416f, 0xaa, 0x21, 0x16, 0xc7, 0xb4, 0xd4, 0x1f, 0xfc >
typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface >	Self
	Own type. More...
typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 >	IID
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x7a70f2fb, 0x1b27, 0x416f, 0xaa, 0x21, 0x16, 0xc7, 0xb4, 0xd4, 0x1f, 0xfc >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...

Detailed Description

All serializable objects have to be derived from this interface.

This allows to serialize them to a network stream, to disk etc. Some objects derived from this implement default functions for some of the member functions. This is the case if the class might be used locally only and never be stored to disk.

Member Function Documentation

virtual void mi::ISerializable::deserialize ( IDeserializer *  deserializer)

pure virtual

Deserializes the object from the given deserializer.

The deserialization has to include all sub elements pointed to but serialized together with this object.

virtual base::Uuid mi::ISerializable::get_class_id ( ) const

pure virtual

Returns the class ID of the object.

The class ID must be unique per registered class. It is used by the serializer to identify the class during serialization. The deserializer uses the class ID reconstruct a corresponding class instance during deserialization.

Returns

The class ID.

virtual void mi::ISerializable::serialize ( ISerializer *  serializer) const

pure virtual

Serializes the object to the given serializer.

The serialization has to include all sub elements pointed to but serialized together with this object.