bas::Serializable Class Reference

The Serializable class, when herited from, allows you to serialize your own classes. More...

#include <bas.hpp>

Public Member Functions
virtual	~Serializable ()=default
	Default destructor. More...
virtual void	makeSerialization (SerializedObject &obj)=0
	Allow serialization of your class. More...
virtual void	makeUnserialization (SerializedObject &obj)=0
	Allow unserialization of your class. More...
void	unserialize (SerializedObject obj)
	Reconstruct object from a SerializedObject. More...
SerializedObject	serialize (void)
	Serialize the class. More...

Detailed Description

The Serializable class, when herited from, allows you to serialize your own classes.

See also

makeSerialization()

makeUnserialization()

Examples

intrication.cpp, and serialization.cpp.

Constructor & Destructor Documentation

~Serializable()

virtual bas::Serializable::~Serializable ( )

virtualdefault

Default destructor.

Member Function Documentation

makeSerialization()

virtual void bas::Serializable::makeSerialization ( SerializedObject &  obj )

pure virtual

Allow serialization of your class.

This function should be overriden, and contain the serialization process of your class.
Note that this function is called by serialize() should not be called directly bu user end. (see Examples)

Parameters

obj	The object to push the data into.

Examples

intrication.cpp, and serialization.cpp.

makeUnserialization()

virtual void bas::Serializable::makeUnserialization ( SerializedObject &  obj )

pure virtual

Allow unserialization of your class.

This function should be overriden, and contain the unserialization process of your class.
Note that this function is called by unserialize() should not be called directly bu user end. (see Examples)

Parameters

obj	The object to pop the data from.

Examples

intrication.cpp, and serialization.cpp.

serialize()

SerializedObject bas::Serializable::serialize ( void  )

inline

Serialize the class.

This function create a SerializedObject of your class.
The serializing process of this function is defined by overriding makeSerialization.

Returns

The SerializedObject containing the data of the class.

unserialize()

void bas::Serializable::unserialize ( SerializedObject  obj )

inline

Reconstruct object from a SerializedObject.

This function copies the SerializedObject before unserializing, meaning that the same object can be used to unserialize multiple times.
The unserializing process of this function is defined by overriding makeUnserialization.

Parameters

obj	SerializedObject to unserialize from.

---

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

• include/bas.hpp