ost::Engine - Engine.

       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++                                    Sun Dec 27 2020                                  ost::Engine(3)

ost::Engine::Engine(std::iostream&stream,EngineModemode,boolcompress=true)
       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. If built using zlib compress can be  used
       to enable compression

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

Engine.

       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

       stream serialization of persistent classes.

__EXPORTEngine&operator<<(Engine&ar,BaseObjectconst&ob)[related]__EXPORTEngine&operator<<(Engine&ar,BaseObjectconst*ob)[related]__EXPORTEngine&operator<<(Engine&ar,boolob)[related]__EXPORTEngine&operator<<(Engine&ar,doubleob)[related]__EXPORTEngine&operator<<(Engine&ar,floatob)[related]__EXPORTEngine&operator<<(Engine&ar,int16ob)[related]__EXPORTEngine&operator<<(Engine&ar,int32ob)[related]__EXPORTEngine&operator<<(Engine&ar,int8ob)[related]template<classx,classy>Engine&operator<<(Engine&ar,std::pair<x,y>&ob)[related]
       serialize a pair of some serializable content to the engine.

   __EXPORTEngine&operator<<(Engine&ar,std::stringob)[related]__EXPORTEngine&operator<<(Engine&ar,Stringob)[related]template<classT>Engine&operator<<(Engine&ar,typenamestd::deque<T>const&ob)[related]
       serialize a deque of some serializable content to the engine

   template<classKey,classValue>Engine&operator<<(Engine&ar,typenamestd::map<Key,Value>const&ob)[related]
       serialize a map with keys/values which both are serializeable to an engine.

   template<classT>Engine&operator<<(Engine&ar,typenamestd::vector<T>const&ob)[related]
       The following are templated classes. serialize a vector of some serializable content to the engine

   __EXPORTEngine&operator<<(Engine&ar,uint16ob)[related]__EXPORTEngine&operator<<(Engine&ar,uint32ob)[related]__EXPORTEngine&operator<<(Engine&ar,uint8ob)[related]__EXPORTEngine&operator>>(Engine&ar,BaseObject&ob)[related]__EXPORTEngine&operator>>(Engine&ar,BaseObject*&ob)[related]__EXPORTEngine&operator>>(Engine&ar,bool&ob)[related]__EXPORTEngine&operator>>(Engine&ar,double&ob)[related]__EXPORTEngine&operator>>(Engine&ar,float&ob)[related]__EXPORTEngine&operator>>(Engine&ar,int16&ob)[related]__EXPORTEngine&operator>>(Engine&ar,int32&ob)[related]__EXPORTEngine&operator>>(Engine&ar,int8&ob)[related]template<classx,classy>Engine&operator>>(Engine&ar,std::pair<x,y>&ob)[related]
       deserialize a pair of some serializable content to the engine.

   __EXPORTEngine&operator>>(Engine&ar,std::string&ob)[related]__EXPORTEngine&operator>>(Engine&ar,String&ob)[related]template<classT>Engine&operator>>(Engine&ar,typenamestd::deque<T>&ob)[related]
       deserialize a deque of deserializable content from an engine.

   template<classKey,classValue>Engine&operator>>(Engine&ar,typenamestd::map<Key,Value>&ob)[related]
       deserialize a map with keys/values which both are serializeable from an engine.

   template<classT>Engine&operator>>(Engine&ar,typenamestd::vector<T>&ob)[related]
       deserialize a vector of deserializable content from an engine.

   __EXPORTEngine&operator>>(Engine&ar,uint16&ob)[related]__EXPORTEngine&operator>>(Engine&ar,uint32&ob)[related]__EXPORTEngine&operator>>(Engine&ar,uint8&ob)[related]

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

       EnumeratormodeReadmodeWrite

boolost::Engine::more()
       This says there are more objects to deserialize.

   voidost::Engine::read(BaseObject&object)
       reads a BaseObject into a reference overwriting the object.

   voidost::Engine::read(BaseObject*&object)
       reads a BaseObject into a pointer allocating memory for the object if necessary.

   voidost::Engine::read(double&i)[inline]
       References CCXX_ENGINEREAD_REF.

   voidost::Engine::read(float&i)[inline]
       References CCXX_ENGINEREAD_REF.

   voidost::Engine::read(int16&i)[inline]
       References CCXX_ENGINEREAD_REF.

   voidost::Engine::read(int32&i)[inline]
       References CCXX_ENGINEREAD_REF.

   voidost::Engine::read(int8&i)[inline]
       References CCXX_ENGINEREAD_REF.

   voidost::Engine::read(std::string&str)voidost::Engine::read(String&str)voidost::Engine::read(uint16&i)[inline]
       References CCXX_ENGINEREAD_REF.

   voidost::Engine::read(uint32&i)[inline]
       References CCXX_ENGINEREAD_REF.

   voidost::Engine::read(uint8&i)[inline]
       References CCXX_ENGINEREAD_REF.

   voidost::Engine::readBinary(uint8*data,uint32size)voidost::Engine::sync()
       This Flushes the buffers and closes the Persistence::Engine this must happen before the underlying stream
       is shut down.

   voidost::Engine::write(constBaseObject&object)[inline]
       writes a BaseObject from a reference.

   voidost::Engine::write(constBaseObject*object)
       writes a BaseObject from a pointer.

   voidost::Engine::write(conststd::string&str)voidost::Engine::write(constString&str)voidost::Engine::write(doublei)[inline]
       References CCXX_ENGINEWRITE_REF.

   voidost::Engine::write(floati)[inline]
       References CCXX_ENGINEWRITE_REF.

   voidost::Engine::write(int16i)[inline]
       References CCXX_ENGINEWRITE_REF.

   voidost::Engine::write(int32i)[inline]
       References CCXX_ENGINEWRITE_REF.

   voidost::Engine::write(int8i)[inline]
       References CCXX_ENGINEWRITE_REF.

   voidost::Engine::write(uint16i)[inline]
       References CCXX_ENGINEWRITE_REF.

   voidost::Engine::write(uint32i)[inline]
       References CCXX_ENGINEWRITE_REF.

   voidost::Engine::write(uint8i)[inline]
       References CCXX_ENGINEWRITE_REF.

   voidost::Engine::writeBinary(constuint8*data,constuint32size)

       ost::Engine - Engine.

       #include <persist.h>

   PublicTypes
       enum EngineMode { modeRead, modeWrite }
           These are the modes the Persistence::Engine can work in.

   PublicMemberFunctionsEngine (std::iostream &stream, EngineMode mode, bool compress=true) 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.
       bool more ()
           This says there are more objects to deserialize.
       virtual ~Engine ()
       void write (const BaseObject &object) THROWS(PersistException)
           writes a BaseObject from a reference.
       void write (const BaseObject *object) THROWS(PersistException)
           writes a BaseObject from a pointer.
       void write (int8 i) THROWS(PersistException)
       void write (uint8 i) THROWS(PersistException)
       void write (int16 i) THROWS(PersistException)
       void write (uint16 i) THROWS(PersistException)
       void write (int32 i) THROWS(PersistException)
       void write (uint32 i) THROWS(PersistException)
       void write (float i) THROWS(PersistException)
       void write (double i) THROWS(PersistException)
       void write (const String &str) THROWS(PersistException)
       void write (const std::string &str) THROWS(PersistException)
       void writeBinary (const uint8 *data, const uint32 size) THROWS(PersistException)
       void read (BaseObject &object) THROWS(PersistException)
           reads a BaseObject into a reference overwriting the object.
       void read (BaseObject *&object) THROWS(PersistException)
           reads a BaseObject into a pointer allocating memory for the object if necessary.
       void read (int8 &i) THROWS(PersistException)
       void read (uint8 &i) THROWS(PersistException)
       void read (int16 &i) THROWS(PersistException)
       void read (uint16 &i) THROWS(PersistException)
       void read (int32 &i) THROWS(PersistException)
       void read (uint32 &i) THROWS(PersistException)
       void read (float &i) THROWS(PersistException)
       void read (double &i) THROWS(PersistException)
       void read (String &str) THROWS(PersistException)
       void read (std::string &str) THROWS(PersistException)
       void readBinary (uint8 *data, uint32 size) THROWS(PersistException)

   RelatedFunctions
       (Note that these are not member functions.)
       __EXPORTEngine & operator>> (Engine &ar, BaseObject &ob) THROWS(PersistException)
       __EXPORTEngine & operator>> (Engine &ar, BaseObject *&ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, BaseObject const &ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, BaseObject const *ob) THROWS(PersistException)
       __EXPORTEngine & operator>> (Engine &ar, int8 &ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, int8 ob) THROWS(PersistException)
       __EXPORTEngine & operator>> (Engine &ar, uint8 &ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, uint8 ob) THROWS(PersistException)
       __EXPORTEngine & operator>> (Engine &ar, int16 &ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, int16 ob) THROWS(PersistException)
       __EXPORTEngine & operator>> (Engine &ar, uint16 &ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, uint16 ob) THROWS(PersistException)
       __EXPORTEngine & operator>> (Engine &ar, int32 &ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, int32 ob) THROWS(PersistException)
       __EXPORTEngine & operator>> (Engine &ar, uint32 &ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, uint32 ob) THROWS(PersistException)
       __EXPORTEngine & operator>> (Engine &ar, float &ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, float ob) THROWS(PersistException)
       __EXPORTEngine & operator>> (Engine &ar, double &ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, double ob) THROWS(PersistException)
       __EXPORTEngine & operator>> (Engine &ar, String &ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, String ob) THROWS(PersistException)
       __EXPORTEngine & operator>> (Engine &ar, std::string &ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, std::string ob) THROWS(PersistException)
       __EXPORTEngine & operator>> (Engine &ar, bool &ob) THROWS(PersistException)
       __EXPORTEngine & operator<< (Engine &ar, bool ob) THROWS(PersistException)
       template<class T > Engine & operator<< (Engine &ar, typename std::vector< T > const &ob)
           THROWS(PersistException)
           The following are templated classes.
       template<class T > Engine & operator>> (Engine &ar, typename std::vector< T > &ob)
           THROWS(PersistException)
           deserialize a vector of deserializable content from an engine.
       template<class T > Engine & operator<< (Engine &ar, typename std::deque< T > const &ob)
           THROWS(PersistException)
           serialize a deque of some serializable content to the engine
       template<class T > Engine & operator>> (Engine &ar, typename std::deque< T > &ob)
           THROWS(PersistException)
           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(PersistException)
           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(PersistException)
           deserialize a map with keys/values which both are serializeable from an engine.
       template<class x , class y > Engine & operator<< (Engine &ar, std::pair< x, y > &ob)
           THROWS(PersistException)
           serialize a pair of some serializable content to the engine.
       template<class x , class y > Engine & operator>> (Engine &ar, std::pair< x, y > &ob)
           THROWS(PersistException)
           deserialize a pair of some serializable content to the engine.