Engine Class Reference

Engine stream serialization of persistent classes. More...

#include <persist.h>

List of all members.

Public Types
enum	EngineMode { modeRead, modeWrite }
	These are the modes the Persistence::Engine can work in. More...
Public Member Functions
	CCXX_MEMBER_EXPORT (void) write(const BaseObject &object) THROWS(Exception)
	writes a BaseObject from a reference.
	CCXX_MEMBER_EXPORT (void) write(const BaseObject *object) THROWS(Exception)
	writes a BaseObject from a pointer.
void	write (int8 i) THROWS(Exception)
void	write (uint8 i) THROWS(Exception)
void	write (int16 i) THROWS(Exception)
void	write (uint16 i) THROWS(Exception)
void	write (int32 i) THROWS(Exception)
void	write (uint32 i) THROWS(Exception)
void	write (float i) THROWS(Exception)
void	write (double i) THROWS(Exception)
	CCXX_MEMBER_EXPORT (void) write(const String &str) THROWS(Exception)
	CCXX_MEMBER_EXPORT (void) writeBinary(const uint8 *data
const uint32 size	THROWS (Exception)
	CCXX_MEMBER_EXPORT (void) read(BaseObject &object) THROWS(Exception)
	reads a BaseObject into a reference overwriting the object.
	CCXX_MEMBER_EXPORT (void) read(BaseObject *&object) THROWS(Exception)
	reads a BaseObject into a pointer allocating memory for the object if necessary.
void	read (int8 &i) THROWS(Exception)
void	read (uint8 &i) THROWS(Exception)
void	read (int16 &i) THROWS(Exception)
void	read (uint16 &i) THROWS(Exception)
void	read (int32 &i) THROWS(Exception)
void	read (uint32 &i) THROWS(Exception)
void	read (float &i) THROWS(Exception)
void	read (double &i) THROWS(Exception)
	CCXX_MEMBER_EXPORT (void) read(String &str) THROWS(Exception)
	CCXX_MEMBER_EXPORT (void) readBinary(uint8 *data
uint32 size	THROWS (Exception)
Public Attributes
CCXX_MEMBER_EXPORT(CCXX_EMPTY) Engine(st	CCXX_MEMBER_EXPORT )(virtual)~Engine()
	This Flushes the buffers and closes the Persistence::Engine this must happen before the underlying stream is shut down.
Related Functions
(Note that these are not member functions.)
	CCXX_EXPORT(Engine &) operator>>(Engine &ar
template<class T> Engine &	operator<< (Engine &ar, typename std::vector< T > const &ob) THROWS(Engine
	serialize a vector of some serializable content to the engine
template<class T> Engine &	operator>> (Engine &ar, typename std::vector< T > &ob) THROWS(Engine
	deserialize a vector of deserializable content from an engine.
template<class T> Engine &	operator<< (Engine &ar, typename std::deque< T > const &ob) THROWS(Engine
	serialize a deque of some serializable content to the engine
template<class T> Engine &	operator>> (Engine &ar, typename std::deque< T > &ob) THROWS(Engine
	deserialize a deque of deserializable content from an engine.
template<class Key, class Value> Engine &	operator<< (Engine &ar, typename std::map< Key, Value > const &ob) THROWS(Engine
	serialize a map with keys/values which both are serializeable to an engine.
template<class Key, class Value> Engine &	operator>> (Engine &ar, typename std::map< Key, Value > &ob) THROWS(Engine
	deserialize a map with keys/values which both are serializeable from an engine.

---

Detailed Description

Engine stream serialization of persistent classes.

This class constructs on a standard C++ STL stream and then operates in the mode specified. The stream passed into the constructor must be a binary mode to function properly.

Author:

Daniel Silverstone

---

Member Enumeration Documentation

enum Engine::EngineMode

These are the modes the Persistence::Engine can work in. Enumeration values: modeRead  modeWrite

---

Member Function Documentation

Engine::CCXX_MEMBER_EXPORT (  void   )

Engine::CCXX_MEMBER_EXPORT (  void   )

Engine::CCXX_MEMBER_EXPORT (  void   )

reads a BaseObject into a pointer allocating memory for the object if necessary.

Engine::CCXX_MEMBER_EXPORT (  void   )

reads a BaseObject into a reference overwriting the object.

Engine::CCXX_MEMBER_EXPORT (  void   )  const

Engine::CCXX_MEMBER_EXPORT (  void   )  const

Engine::CCXX_MEMBER_EXPORT (  void   )  const

writes a BaseObject from a pointer.

Engine::CCXX_MEMBER_EXPORT (  void   )  const [inline]

writes a BaseObject from a reference.

void Engine::read (  double &  i  )  [inline]

void Engine::read (  float &  i  )  [inline]

void Engine::read (  uint32 &  i  )  [inline]

void Engine::read (  int32 &  i  )  [inline]

void Engine::read (  uint16 &  i  )  [inline]

void Engine::read (  int16 &  i  )  [inline]

void Engine::read (  uint8 &  i  )  [inline]

void Engine::read (  int8 &  i  )  [inline]

uint32 size Engine::THROWS (  Exception   )

const uint32 size Engine::THROWS (  Exception   )

void Engine::write (  double  i  )  [inline]

void Engine::write (  float  i  )  [inline]

void Engine::write (  uint32  i  )  [inline]

void Engine::write (  int32  i  )  [inline]

void Engine::write (  uint16  i  )  [inline]

void Engine::write (  int16  i  )  [inline]

void Engine::write (  uint8  i  )  [inline]

void Engine::write (  int8  i  )  [inline]

---

Friends And Related Function Documentation

CCXX_EXPORT (  Engine &   )  [related]

template<class Key, class Value> Engine & operator<< (  Engine &  ar, typename std::map< Key, Value > const &  ob )  [related]

serialize a map with keys/values which both are serializeable to an engine.

template<class T> Engine & operator<< (  Engine &  ar, typename std::deque< T > const &  ob )  [related]

serialize a deque of some serializable content to the engine

template<class T> Engine & operator<< (  Engine &  ar, typename std::vector< T > const &  ob )  [related]

serialize a vector of some serializable content to the engine

template<class Key, class Value> Engine & operator>> (  Engine &  ar, typename std::map< Key, Value > &  ob )  [related]

deserialize a map with keys/values which both are serializeable from an engine.

template<class T> Engine & operator>> (  Engine &  ar, typename std::deque< T > &  ob )  [related]

deserialize a deque of deserializable content from an engine.

template<class T> Engine & operator>> (  Engine &  ar, typename std::vector< T > &  ob )  [related]

deserialize a vector of deserializable content from an engine.

---

Member Data Documentation

CCXX_MEMBER_EXPORT (CCXX_EMPTY) Engine(st Engine::CCXX_MEMBER_EXPORT)(virtual) ~Engine()

This Flushes the buffers and closes the Persistence::Engine this must happen before the underlying stream is shut down.

---

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

• persist.h

---