enum EngineMode { modeRead, modeWrite }

These are the modes the Persistence::Engine can work in.

Engine (std::iostream &stream, EngineMode mode) THROWS(PersistException)

Constructs a Persistence::Engine with the specified stream in the given mode. void sync ()

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

void write (const BaseObject &object) THROWS(Exception)

writes a BaseObject from a reference. 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)

void write (const String &str) THROWS(Exception)

void write (const std::string &str) THROWS(Exception)

void writeBinary (const uint8 *data, const uint32 size) THROWS(Exception)

void read (BaseObject &object) THROWS(Exception)

reads a BaseObject into a reference overwriting the object. 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)

void read (String &str) THROWS(Exception)

void read (std::string &str) THROWS(Exception)

void readBinary (uint8 *data, uint32 size) THROWS(Exception)

(Note that these are not member functions.) template<class T> Engine & operator>> (Engine &ar, typename std::vector< T > &ob) THROWS(Engine

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

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

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

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

template<class x, class y> Engine & operator<< (Engine &ar, std::pair< x, y > &ob) THROWS(Engine

template<class x, class y> Engine & operator>> (Engine &ar, std::pair< x, y > &ob) THROWS(Engine

These are the modes the Persistence::Engine can work in.

Enumerator:

modeRead

modeWrite

Constructs a Persistence::Engine with the specified stream in the given mode.

The stream must be initialised properly prior to this call or problems will ensue.

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

reads a BaseObject into a reference overwriting the object.

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

writes a BaseObject from a pointer.

writes a BaseObject from a reference.

serialize a pair of some serializable content to the engine.

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

serialize a deque of some serializable content to the engine

deserialize a pair of some serializable content to the engine.

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

deserialize a deque of deserializable content from an engine.

deserialize a vector of deserializable content from an engine.