Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

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. More...

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

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 )


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 )
 


The documentation for this class was generated from the following file:
Generated at Thu Jan 24 11:06:03 2002 for CommonC++ by doxygen1.2.10 written by Dimitri van Heesch, © 1997-2001