---

ost::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 Methods
	Engine (std::iostream &stream, EngineMode mode) throw ( PersistException )
	Constructs a Persistence::Engine with the specified stream in the given mode.
virtual	~Engine ()
	This Flushes the buffers and closes the Persistence::Engine this must happen before the underlying stream is shut down.
void	write (const BaseObject *object) throw ( Exception )
void	write (int8 i) throw ( Exception )
void	write (uint8 i) throw ( Exception )
void	write (int16 i) throw ( Exception )
void	write (uint16 i) throw ( Exception )
void	write (int32 i) throw ( Exception )
void	write (uint32 i) throw ( Exception )
void	write (int64 i) throw ( Exception )
void	write (uint64 i) throw ( Exception )
void	write (float i) throw ( Exception )
void	write (double i) throw ( Exception )
void	write (const std::string &str) throw ( Exception )
void	writeBinary (const uint8 *data, const uint32 size) throw ( Exception )
void	read (BaseObject *&object) throw ( Exception )
void	read (int8 &i) throw ( Exception )
void	read (uint8 &i) throw ( Exception )
void	read (int16 &i) throw ( Exception )
void	read (uint16 &i) throw ( Exception )
void	read (int32 &i) throw ( Exception )
void	read (uint32 &i) throw ( Exception )
void	read (int64 &i) throw ( Exception )
void	read (uint64 &i) throw ( Exception )
void	read (float &i) throw ( Exception )
void	read (double &i) throw ( Exception )
void	read (std::string &str) throw ( Exception )
void	readBinary (uint8 *data, uint32 size) throw ( Exception )
Related Functions
(Note that these are not member functions.)
Engine &	operator>> (Engine &ar, BaseObject *&ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, BaseObject const *ob) throw(Engine::Exception)
Engine &	operator>> (Engine &ar, int8 &ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, int8 ob) throw(Engine::Exception)
Engine &	operator>> (Engine &ar, uint8 &ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, uint8 ob) throw(Engine::Exception)
Engine &	operator>> (Engine &ar, int16 &ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, int16 ob) throw(Engine::Exception)
Engine &	operator>> (Engine &ar, uint16 &ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, uint16 ob) throw(Engine::Exception)
Engine &	operator>> (Engine &ar, int32 &ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, int32 ob) throw(Engine::Exception)
Engine &	operator>> (Engine &ar, uint32 &ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, uint32 ob) throw(Engine::Exception)
Engine &	operator>> (Engine &ar, int64 &ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, int64 ob) throw(Engine::Exception)
Engine &	operator>> (Engine &ar, uint64 &ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, uint64 ob) throw(Engine::Exception)
Engine &	operator>> (Engine &ar, float &ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, float ob) throw(Engine::Exception)
Engine &	operator>> (Engine &ar, double &ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, double ob) throw(Engine::Exception)
Engine &	operator>> (Engine &ar, std::string &ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, std::string ob) throw(Engine::Exception)
Engine &	operator>> (Engine &ar, bool &ob) throw(Engine::Exception)
Engine &	operator<< (Engine &ar, bool ob) throw(Engine::Exception)
template<class T> Engine &	operator<< (Engine &ar, typename std::vector< T > const &ob) throw(Engine::Exception)
	serialize a vector of some serializable content to the engine
template<class T> Engine &	operator>> (Engine &ar, typename std::vector< T > &ob) throw(Engine::Exception)
	deserialize a vector of deserializable content from an engine.
template<class Key, class Value> Engine &	operator<< (Engine &ar, typename std::map< Key, Value > const &ob) throw(Engine::Exception)
	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) throw(Engine::Exception)
	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.

Author:

Daniel Silverstone

---

Member Enumeration Documentation

enum ost::Engine::EngineMode

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

---

Constructor & Destructor Documentation

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

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.

virtual ost::Engine::~Engine (    )  [virtual]

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

---

Member Function Documentation

void ost::Engine::read (  std::string &    str )  throw ( Exception )

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

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

void ost::Engine::read (  uint64 &    i )  throw ( Exception ) [inline]

void ost::Engine::read (  int64 &    i )  throw ( Exception ) [inline]

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

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

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

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

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

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

void ost::Engine::read (  BaseObject *&    object )  throw ( Exception )

void ost::Engine::readBinary (  uint8 *    data, uint32    size )  throw ( Exception )

void ost::Engine::write (  const std::string &    str )  throw ( Exception )

void ost::Engine::write (  double    i )  throw ( Exception ) [inline]

void ost::Engine::write (  float    i )  throw ( Exception ) [inline]

void ost::Engine::write (  uint64    i )  throw ( Exception ) [inline]

void ost::Engine::write (  int64    i )  throw ( Exception ) [inline]

void ost::Engine::write (  uint32    i )  throw ( Exception ) [inline]

void ost::Engine::write (  int32    i )  throw ( Exception ) [inline]

void ost::Engine::write (  uint16    i )  throw ( Exception ) [inline]

void ost::Engine::write (  int16    i )  throw ( Exception ) [inline]

void ost::Engine::write (  uint8    i )  throw ( Exception ) [inline]

void ost::Engine::write (  int8    i )  throw ( Exception ) [inline]

void ost::Engine::write (  const BaseObject *    object )  throw ( Exception )

void ost::Engine::writeBinary (  const uint8 *    data, const uint32    size )  throw ( Exception )

---

Friends And Related Function Documentation

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

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

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

serialize a vector of some serializable content to the engine

Engine & operator<< (  Engine &    ar, bool    ob )  throw(Engine::Exception) [related]

Engine & operator<< (  Engine &    ar, std::string    ob )  throw(Engine::Exception) [related]

Engine & operator<< (  Engine &    ar, double    ob )  throw(Engine::Exception) [related]

Engine & operator<< (  Engine &    ar, float    ob )  throw(Engine::Exception) [related]

Engine & operator<< (  Engine &    ar, uint64    ob )  throw(Engine::Exception) [related]

Engine & operator<< (  Engine &    ar, int64    ob )  throw(Engine::Exception) [related]

Engine & operator<< (  Engine &    ar, uint32    ob )  throw(Engine::Exception) [related]

Engine & operator<< (  Engine &    ar, int32    ob )  throw(Engine::Exception) [related]

Engine & operator<< (  Engine &    ar, uint16    ob )  throw(Engine::Exception) [related]

Engine & operator<< (  Engine &    ar, int16    ob )  throw(Engine::Exception) [related]

Engine & operator<< (  Engine &    ar, uint8    ob )  throw(Engine::Exception) [related]

Engine & operator<< (  Engine &    ar, int8    ob )  throw(Engine::Exception) [related]

Engine & operator<< (  Engine &    ar, BaseObject const *    ob )  throw(Engine::Exception) [related]

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

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

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

deserialize a vector of deserializable content from an engine.

Engine & operator>> (  Engine &    ar, bool &    ob )  throw(Engine::Exception) [related]

Engine & operator>> (  Engine &    ar, std::string &    ob )  throw(Engine::Exception) [related]

Engine & operator>> (  Engine &    ar, double &    ob )  throw(Engine::Exception) [related]

Engine & operator>> (  Engine &    ar, float &    ob )  throw(Engine::Exception) [related]

Engine & operator>> (  Engine &    ar, uint64 &    ob )  throw(Engine::Exception) [related]

Engine & operator>> (  Engine &    ar, int64 &    ob )  throw(Engine::Exception) [related]

Engine & operator>> (  Engine &    ar, uint32 &    ob )  throw(Engine::Exception) [related]

Engine & operator>> (  Engine &    ar, int32 &    ob )  throw(Engine::Exception) [related]

Engine & operator>> (  Engine &    ar, uint16 &    ob )  throw(Engine::Exception) [related]

Engine & operator>> (  Engine &    ar, int16 &    ob )  throw(Engine::Exception) [related]

Engine & operator>> (  Engine &    ar, uint8 &    ob )  throw(Engine::Exception) [related]

Engine & operator>> (  Engine &    ar, int8 &    ob )  throw(Engine::Exception) [related]

Engine & operator>> (  Engine &    ar, BaseObject *&    ob )  throw(Engine::Exception) [related]

---

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

• persist.h

---