elm::serial::Unserializer Class Reference

#include <elm/serial/Unserializer.h>

Inheritance diagram for elm::serial::Unserializer:

Public Member Functions
virtual	~Unserializer (void)
template<class T >
void	read (T &val)
template<class T >
void	read (T *&val)
virtual void	close (void)=0
virtual void	readPointer (SerialClass &clazz, void *&ptr)=0
virtual void	beginObject (CString name, void *ptr)=0
virtual void	endObject (void)=0
virtual bool	beginField (CString name)=0
virtual bool	beginList (void)=0
virtual void	endList (void)=0
virtual bool	nextItem (void)=0
virtual int	readEnum (Pair< elm::CString, int > values[])=0
virtual void	read (bool &val)=0
virtual void	read (char &val)=0
virtual void	read (unsigned char &val)=0
virtual void	read (short &val)=0
virtual void	read (unsigned short &val)=0
virtual void	read (long &val)=0
virtual void	read (unsigned long &val)=0
virtual void	read (int &val)=0
virtual void	read (unsigned int &val)=0
virtual void	read (long long &val)=0
virtual void	read (unsigned long long &val)=0
virtual void	read (float &val)=0
virtual void	read (double &val)=0
virtual void	read (CString &val)=0
virtual void	read (String &val)=0
template<class T >
void	processField (CString name, T &val)
Name of the field.
Returns True if the field may be unserialised, false else.
virtual void	endField (void)=0
template<class T >
Unserializer &	operator>> (T &val)

Detailed Description

This interface must be implemented by unserializer engines.

Deprecated:

Constructor & Destructor Documentation

virtual elm::serial::Unserializer::~Unserializer ( void  )

virtual

Member Function Documentation

bool elm::serial::Unserializer::beginField ( CString  name )

pure virtual

A field begin to be unserialized.

Implemented in elm::serial::XOMUnserializer.

Referenced by processField().

virtual bool elm::serial::Unserializer::beginList ( void  )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::beginObject ( CString  name, void *  ptr  )

pure virtual

Implemented in elm::serial::XOMUnserializer.

Referenced by read().

void elm::serial::Unserializer::close ( void  )

pure virtual

This method must be called at the end of the unserialization in order to resolve lacking refercnes.

Implemented in elm::serial::XOMUnserializer.

void elm::serial::Unserializer::endField ( void  )

pure virtual

The current field unserialization is ended.

Implemented in elm::serial::XOMUnserializer.

Referenced by processField().

virtual void elm::serial::Unserializer::endList ( void  )

pure virtual

Implemented in elm::serial::XOMUnserializer.

void elm::serial::Unserializer::endObject ( void  )

pure virtual

End of unserialization of an object.

Implemented in elm::serial::XOMUnserializer.

Referenced by read().

virtual bool elm::serial::Unserializer::nextItem ( void  )

pure virtual

Implemented in elm::serial::XOMUnserializer.

template<class T >

Unserializer & elm::serial::Unserializer::operator>>

(

T &

val

)

Perform unserialization of the given value.

Parameters

val	Value to unserialize in.

References read().

template<class T >

void elm::serial::Unserializer::processField	(	CString	name,
		T &	val
	)

References beginField(), and endField().

template<class T >

void elm::serial::Unserializer::read

(

T &

val

)

Unserialize the given object. There is specialization for each base type.

Parameters

val	Variable to unserialize in.

References beginObject(), and endObject().

Referenced by operator>>().

template<class T >

void elm::serial::Unserializer::read

(

T *&

val

)

References readPointer().

virtual void elm::serial::Unserializer::read ( bool &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( char &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( unsigned char &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( short &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( unsigned short &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( long &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( unsigned long &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( int &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( unsigned int &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( long long &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( unsigned long long &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( float &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( double &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( CString &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual void elm::serial::Unserializer::read ( String &  val )

pure virtual

Implemented in elm::serial::XOMUnserializer.

virtual int elm::serial::Unserializer::readEnum ( Pair< elm::CString, int >  values[] )

pure virtual

Implemented in elm::serial::XOMUnserializer.

void elm::serial::Unserializer::readPointer ( SerialClass &  clazz, void *&  ptr  )

pure virtual

Unserialize a pointer.

Parameters

ptr	Pointer to record in.

Implemented in elm::serial::XOMUnserializer.

Referenced by read().

---

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

• include/elm/serial/Unserializer.h
• src/serial_Unserializer.cpp