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

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

__MEMBER_EXPORT Engine (std::iostream &stream, EngineMode mode) THROWS(PersistException)
 Constructs a Persistence::Engine with the specified stream in the given mode. More...

__MEMBER_EXPORT ~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) THROWS(Exception)
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 (int64 i) THROWS(Exception)
void Write (uint64 i) THROWS(Exception)
void Write (float i) THROWS(Exception)
void Write (double i) 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)
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 (int64 &i) THROWS(Exception)
void Read (uint64 &i) THROWS(Exception)
void Read (float &i) THROWS(Exception)
void Read (double &i) THROWS(Exception)
void Read (std::string &str) THROWS(Exception)
void ReadBinary (uint8 *data, uint32 size) THROWS(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 Engine::EngineMode
 

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

Enumeration values:
modeRead  
modeWrite  


Constructor & Destructor Documentation

__MEMBER_EXPORT Engine::Engine std::iostream &   stream,
EngineMode   mode
 

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.

__MEMBER_EXPORT Engine::~Engine  
 

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


Member Function Documentation

void Engine::Read std::string &   str
 

void Engine::Read double &   i [inline]
 

void Engine::Read float &   i [inline]
 

void Engine::Read uint64 &   i [inline]
 

void Engine::Read int64 &   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]
 

void Engine::Read BaseObject *&   object
 

void Engine::ReadBinary uint8 *   data,
uint32   size
 

void Engine::Write const std::string &   str
 

void Engine::Write double   i [inline]
 

void Engine::Write float   i [inline]
 

void Engine::Write uint64   i [inline]
 

void Engine::Write int64   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]
 

void Engine::Write const BaseObject *   object
 

void Engine::WriteBinary const uint8 *   data,
const uint32   size
 


The documentation for this class was generated from the following file:
Generated at Tue Oct 16 11:17:17 2001 for CommonC++ by doxygen1.2.10 written by Dimitri van Heesch, © 1997-2001