Serializer< A > Class Template Reference

A default template class to serialize an object of class A. More...

#include <Serializer.h>

List of all members.

Static Public Member Functions
static unsigned char *	construct (A *obj, unsigned char *buf)
	Construct an object obj from the serialized data stream (buf).
static unsigned char *	serialize (const A &obj, unsigned char *buf)
	Serialize an object obj to the stream (buf).
static int	getSerializedSize (const A &obj)
	Return the size of serialized data of obj.
static bool	needsSerializing ()
	Return whether this needs serialization in communication.

---

Detailed Description

template<typename A>
class Serializer< A >

A default template class to serialize an object of class A.

This is default implementation and invokes A::serialize(buf), A::construct(buf), A::getSerializedSize() and A::needsSerializing().

Instances for some primitive types are written in this file. If you use other primitive types, you should make instances for them. For classes used in skeletons, i.e. dist_pair and matrix, you don't have to are also written in this file. If you use classes except those used in skeletons, i.e. dist_pair and matrix, , you should do either of the following: 1. add members A::serialize(buf), A::construct(buf), A::getSerializedSize() and A::needsSerializing() which are used in default Shadower, 2. write an instance of Shadower for the class.

Definition at line 29 of file Serializer.h.

---

Member Function Documentation

template<typename A> static unsigned char* Serializer< A >::construct (  A *  obj, unsigned char *  buf )  [inline, static]

Construct an object obj from the serialized data stream (buf). This function just invokes A::construct(buf). Parameters: obj  an object to be constructed. buf  a serialized data stream from which the object is constructed. Returns: A pointer indicating the head of the rest of the stream. See also: matrix<A>::construct() Definition at line 40 of file Serializer.h. Referenced by Serializer< std::pair< A, B > >::construct(), Serializer< const std::pair< A, B > >::construct(), and matrix< A >::construct().

template<typename A> static int Serializer< A >::getSerializedSize (  const A &  obj  )  [inline, static]

Return the size of serialized data of obj. This function just invokes A::getSerializedSize(). Parameters: obj  an object to be serialized. Returns: The size of serialized data of obj. See also: matrix<A>::getSerializedSize() Definition at line 63 of file Serializer.h. Referenced by Serializer< std::pair< A, B > >::getSerializedSize(), Serializer< const std::pair< A, B > >::getSerializedSize(), and matrix< A >::getSerializedSize().

template<typename A> static bool Serializer< A >::needsSerializing (   )  [inline, static]

Return whether this needs serialization in communication. This function just invokes A::needsSerializing(). See also: matrix<A>::needsSerializing() Definition at line 72 of file Serializer.h.

template<typename A> static unsigned char* Serializer< A >::serialize (  const A &  obj, unsigned char *  buf )  [inline, static]

Serialize an object obj to the stream (buf). This function just invokes A::serialize(buf). Parameters: obj  an object to be serialized. buf  a stream to which the object is serialized. Returns: A pointer indicating the tail of the stream. See also: matrix<A>::serialize() Definition at line 52 of file Serializer.h. Referenced by Serializer< std::pair< A, B > >::serialize(), Serializer< const std::pair< A, B > >::serialize(), and matrix< A >::serialize().

---

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

• libraries/matrix/Serializer.h

---