\section{ost::Engine Class Reference}
\label{classost_1_1_engine}\index{ost::Engine@{ost::Engine}}
Enginestream serialization of persistent classes.
{\tt \#include $<$persist.h$>$}
\subsection*{Public Types}
\begin{CompactItemize}
\item
enum {\bf Engine\-Mode} \{ {\bf mode\-Read},
{\bf mode\-Write}
\}
\begin{CompactList}\small\item\em These are the modes the Persistence::Engine can work in. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf Engine} (std::iostream \&stream, {\bf Engine\-Mode} mode) THROWS(Persist\-Exception)
\begin{CompactList}\small\item\em Constructs a Persistence::Engine with the specified stream in the given mode. \item\end{CompactList}\item
void {\bf sync} ()
\begin{CompactList}\small\item\em This Flushes the buffers and closes the Persistence::Engine this must happen before the underlying stream is shut down. \item\end{CompactList}\item
virtual {\bf $\sim$Engine} ()
\item
void {\bf write} (const {\bf Base\-Object} \&object) THROWS(Persist\-Exception)
\begin{CompactList}\small\item\em writes a {\bf Base\-Object}{\rm (p.\,\pageref{classost_1_1_base_object})} from a reference. \item\end{CompactList}\item
void {\bf write} (const {\bf Base\-Object} $\ast$object) THROWS(Persist\-Exception)
\begin{CompactList}\small\item\em writes a {\bf Base\-Object}{\rm (p.\,\pageref{classost_1_1_base_object})} from a pointer. \item\end{CompactList}\item
void {\bf write} ({\bf int8} i) THROWS(Persist\-Exception)
\item
void {\bf write} ({\bf uint8} i) THROWS(Persist\-Exception)
\item
void {\bf write} ({\bf int16} i) THROWS(Persist\-Exception)
\item
void {\bf write} ({\bf uint16} i) THROWS(Persist\-Exception)
\item
void {\bf write} ({\bf int32} i) THROWS(Persist\-Exception)
\item
void {\bf write} ({\bf uint32} i) THROWS(Persist\-Exception)
\item
void {\bf write} (float i) THROWS(Persist\-Exception)
\item
void {\bf write} (double i) THROWS(Persist\-Exception)
\item
void {\bf write} (const {\bf String} \&str) THROWS(Persist\-Exception)
\item
void {\bf write} (const std::string \&str) THROWS(Persist\-Exception)
\item
void {\bf write\-Binary} (const {\bf uint8} $\ast$data, const {\bf uint32} size) THROWS(Persist\-Exception)
\item
void {\bf read} ({\bf Base\-Object} \&object) THROWS(Persist\-Exception)
\begin{CompactList}\small\item\em reads a {\bf Base\-Object}{\rm (p.\,\pageref{classost_1_1_base_object})} into a reference overwriting the object. \item\end{CompactList}\item
void {\bf read} ({\bf Base\-Object} $\ast$\&object) THROWS(Persist\-Exception)
\begin{CompactList}\small\item\em reads a {\bf Base\-Object}{\rm (p.\,\pageref{classost_1_1_base_object})} into a pointer allocating memory for the object if necessary. \item\end{CompactList}\item
void {\bf read} ({\bf int8} \&i) THROWS(Persist\-Exception)
\item
void {\bf read} ({\bf uint8} \&i) THROWS(Persist\-Exception)
\item
void {\bf read} ({\bf int16} \&i) THROWS(Persist\-Exception)
\item
void {\bf read} ({\bf uint16} \&i) THROWS(Persist\-Exception)
\item
void {\bf read} ({\bf int32} \&i) THROWS(Persist\-Exception)
\item
void {\bf read} ({\bf uint32} \&i) THROWS(Persist\-Exception)
\item
void {\bf read} (float \&i) THROWS(Persist\-Exception)
\item
void {\bf read} (double \&i) THROWS(Persist\-Exception)
\item
void {\bf read} ({\bf String} \&str) THROWS(Persist\-Exception)
\item
void {\bf read} (std::string \&str) THROWS(Persist\-Exception)
\item
void {\bf read\-Binary} ({\bf uint8} $\ast$data, {\bf uint32} size) THROWS(Persist\-Exception)
\end{CompactItemize}
\subsection*{Related Functions}
(Note that these are not member functions.) \begin{CompactItemize}
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, {\bf Base\-Object} \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, {\bf Base\-Object} $\ast$\&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, {\bf Base\-Object} const \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, {\bf Base\-Object} const $\ast$ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, {\bf int8} \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, {\bf int8} ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, {\bf uint8} \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, {\bf uint8} ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, {\bf int16} \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, {\bf int16} ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, {\bf uint16} \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, {\bf uint16} ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, {\bf int32} \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, {\bf int32} ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, {\bf uint32} \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, {\bf uint32} ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, float \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, float ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, double \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, double ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, {\bf String} \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, {\bf String} ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, std::string \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, std::string ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, bool \&ob) THROWS(Persist\-Exception)
\item
\_\-\_\-EXPORT {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, bool ob) THROWS(Persist\-Exception)
\item
template$<$class T$>$ {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, typename std::vector$<$ T $>$ const \&ob) THROWS(Persist\-Exception)
\item
template$<$class T$>$ {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, typename std::vector$<$ T $>$ \&ob) THROWS(Persist\-Exception)
\item
template$<$class T$>$ {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, typename std::deque$<$ T $>$ const \&ob) THROWS(Persist\-Exception)
\item
template$<$class T$>$ {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, typename std::deque$<$ T $>$ \&ob) THROWS(Persist\-Exception)
\item
template$<$class Key, class Value$>$ {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, typename std::map$<$ Key, Value $>$ const \&ob) THROWS(Persist\-Exception)
\item
template$<$class Key, class Value$>$ {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, typename std::map$<$ Key, Value $>$ \&ob) THROWS(Persist\-Exception)
\item
template$<$class x, class y$>$ {\bf Engine} \& {\bf operator$<$$<$} ({\bf Engine} \&ar, std::pair$<$ x, y $>$ \&ob) THROWS(Persist\-Exception)
\item
template$<$class x, class y$>$ {\bf Engine} \& {\bf operator$>$$>$} ({\bf Engine} \&ar, std::pair$<$ x, y $>$ \&ob) THROWS(Persist\-Exception)
\end{CompactItemize}
\subsection{Detailed Description}
Enginestream serialization of persistent classes.
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.
\begin{Desc}
\item[Author:]Daniel Silverstone \end{Desc}
\subsection{Member Enumeration Documentation}
\index{ost::Engine@{ost::Engine}!EngineMode@{EngineMode}}
\index{EngineMode@{EngineMode}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf ost::Engine::Engine\-Mode}}\label{classost_1_1_engine_79c3c9a0b5e4539bfd628e74abb9dcd7}
These are the modes the Persistence::Engine can work in.
\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{modeRead@{modeRead}!ost::Engine@{ost::Engine}}\index{ost::Engine@{ost::Engine}!modeRead@{modeRead}}\item[{\em
mode\-Read\label{classost_1_1_engine_79c3c9a0b5e4539bfd628e74abb9dcd7925cc9ec51802d448af134176a5a0378}
}]\index{modeWrite@{modeWrite}!ost::Engine@{ost::Engine}}\index{ost::Engine@{ost::Engine}!modeWrite@{modeWrite}}\item[{\em
mode\-Write\label{classost_1_1_engine_79c3c9a0b5e4539bfd628e74abb9dcd7b0d24e68c9ca4dc79cda2c8362c9c836}
}]\end{description}
\end{Desc}
\subsection{Constructor \& Destructor Documentation}
\index{ost::Engine@{ost::Engine}!Engine@{Engine}}
\index{Engine@{Engine}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Engine::Engine (std::iostream \& {\em stream}, {\bf Engine\-Mode} {\em mode})}\label{classost_1_1_engine_f5b959889de8a41e75486c3afae6313f}
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. \index{ost::Engine@{ost::Engine}!~Engine@{$\sim$Engine}}
\index{~Engine@{$\sim$Engine}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual ost::Engine::$\sim$Engine ()\hspace{0.3cm}{\tt [virtual]}}\label{classost_1_1_engine_a781f026e04726822c2375366825e38d}
\subsection{Member Function Documentation}
\index{ost::Engine@{ost::Engine}!read@{read}}
\index{read@{read}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read (std::string \& {\em str})}\label{classost_1_1_engine_155b0a9d9c6038708e9d482c78cd8d9b}
\index{ost::Engine@{ost::Engine}!read@{read}}
\index{read@{read}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read ({\bf String} \& {\em str})}\label{classost_1_1_engine_0dd0b0fab41279277623542546ae8c09}
\index{ost::Engine@{ost::Engine}!read@{read}}
\index{read@{read}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read (double \& {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_1c5bd34e23ebc998518fa83986b048d1}
\index{ost::Engine@{ost::Engine}!read@{read}}
\index{read@{read}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read (float \& {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_e73f56f89c7ac2a52a3c8a2d962c3c9b}
\index{ost::Engine@{ost::Engine}!read@{read}}
\index{read@{read}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read ({\bf uint32} \& {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_426994ea8ea90d921197dd9af3adb3fe}
\index{ost::Engine@{ost::Engine}!read@{read}}
\index{read@{read}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read ({\bf int32} \& {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_db42601d5792ebfb806e181dd09472c1}
\index{ost::Engine@{ost::Engine}!read@{read}}
\index{read@{read}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read ({\bf uint16} \& {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_a4654c1d0d1d8f4d31551d60b55b37a4}
\index{ost::Engine@{ost::Engine}!read@{read}}
\index{read@{read}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read ({\bf int16} \& {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_ad3f7a3e3e66ea0e41ccfbb26e6bdcef}
\index{ost::Engine@{ost::Engine}!read@{read}}
\index{read@{read}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read ({\bf uint8} \& {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_4f018b27119d1e382b1c46a2778a6fc8}
\index{ost::Engine@{ost::Engine}!read@{read}}
\index{read@{read}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read ({\bf int8} \& {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_c3f4e91e6bf01957937399af29048da3}
\index{ost::Engine@{ost::Engine}!read@{read}}
\index{read@{read}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read ({\bf Base\-Object} $\ast$\& {\em object})}\label{classost_1_1_engine_58549c5240acf31c75b7d8696937ecd5}
reads a {\bf Base\-Object}{\rm (p.\,\pageref{classost_1_1_base_object})} into a pointer allocating memory for the object if necessary.
\index{ost::Engine@{ost::Engine}!read@{read}}
\index{read@{read}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read ({\bf Base\-Object} \& {\em object})}\label{classost_1_1_engine_a39a5fda85b6dd96d9def855974f754a}
reads a {\bf Base\-Object}{\rm (p.\,\pageref{classost_1_1_base_object})} into a reference overwriting the object.
\index{ost::Engine@{ost::Engine}!readBinary@{readBinary}}
\index{readBinary@{readBinary}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::read\-Binary ({\bf uint8} $\ast$ {\em data}, {\bf uint32} {\em size})}\label{classost_1_1_engine_716a0c85e4b60cfc968ec923f5f99a51}
\index{ost::Engine@{ost::Engine}!sync@{sync}}
\index{sync@{sync}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::sync ()}\label{classost_1_1_engine_4725b0fa41c4ffd838c2ae782d364b37}
This Flushes the buffers and closes the Persistence::Engine this must happen before the underlying stream is shut down.
\index{ost::Engine@{ost::Engine}!write@{write}}
\index{write@{write}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write (const std::string \& {\em str})}\label{classost_1_1_engine_f7ab15352dd57926ec22a9645b29b92c}
\index{ost::Engine@{ost::Engine}!write@{write}}
\index{write@{write}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write (const {\bf String} \& {\em str})}\label{classost_1_1_engine_b507d23a54555b32a55e649dabdb54ca}
\index{ost::Engine@{ost::Engine}!write@{write}}
\index{write@{write}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write (double {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_537ec0a333b5e08e94bbfa5f6c08deea}
\index{ost::Engine@{ost::Engine}!write@{write}}
\index{write@{write}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write (float {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_1519781190b2e05f6ebfdd9a8cd7705f}
\index{ost::Engine@{ost::Engine}!write@{write}}
\index{write@{write}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write ({\bf uint32} {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_c69e28310bc769fe2bbcfee9f638e271}
\index{ost::Engine@{ost::Engine}!write@{write}}
\index{write@{write}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write ({\bf int32} {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_70cfa0027de39dd150eed711fbf8c268}
\index{ost::Engine@{ost::Engine}!write@{write}}
\index{write@{write}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write ({\bf uint16} {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_c040b19a3c2d7093bae7677554b1ccd5}
\index{ost::Engine@{ost::Engine}!write@{write}}
\index{write@{write}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write ({\bf int16} {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_d7c1a41c518c4e346d7e30bf7ea1b831}
\index{ost::Engine@{ost::Engine}!write@{write}}
\index{write@{write}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write ({\bf uint8} {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_30566d3564980513d8530cc226decb3d}
\index{ost::Engine@{ost::Engine}!write@{write}}
\index{write@{write}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write ({\bf int8} {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_f4aa5f27b2e837e38de4f99de63a8ff2}
\index{ost::Engine@{ost::Engine}!write@{write}}
\index{write@{write}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write (const {\bf Base\-Object} $\ast$ {\em object})}\label{classost_1_1_engine_01659ba91af98283534ff427f9215c45}
writes a {\bf Base\-Object}{\rm (p.\,\pageref{classost_1_1_base_object})} from a pointer.
\index{ost::Engine@{ost::Engine}!write@{write}}
\index{write@{write}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write (const {\bf Base\-Object} \& {\em object})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_engine_fb0634ed15df8ba8fe337d148cda67ef}
writes a {\bf Base\-Object}{\rm (p.\,\pageref{classost_1_1_base_object})} from a reference.
\index{ost::Engine@{ost::Engine}!writeBinary@{writeBinary}}
\index{writeBinary@{writeBinary}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Engine::write\-Binary (const {\bf uint8} $\ast$ {\em data}, const {\bf uint32} {\em size})}\label{classost_1_1_engine_24c4ccbdcf660b9b09b87674eb8009fb}
\subsection{Friends And Related Function Documentation}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class x, class y$>$ {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, std::pair$<$ x, y $>$ \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_05508a982481fd6699d53488e6390aa5}
serialize a pair of some serializable content to the engine. \index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Key, class Value$>$ {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, typename std::map$<$ Key, Value $>$ const \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_d2c656c2556ef94dcb67db48740aba51}
serialize a map with keys/values which both are serializeable to an engine. \index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, typename std::deque$<$ T $>$ const \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_7367b9915f8ef3a7f9e5eecd686774bc}
serialize a deque of some serializable content to the engine \index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, typename std::vector$<$ T $>$ const \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_23debe9c4748be2031a7e515e027368b}
serialize a vector of some serializable content to the engine \index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, bool {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_92899e6c8393aa36a2babdfe8d8d5d58}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, std::string {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_8af05b56060b46f9c2cec747752e357f}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, {\bf String} {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_bee8ee8c7840525a6a941f2e78e51ed6}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, double {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_a165c3c650318aeda57db5188dc5a271}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, float {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_f288a065193caf2635dce3d029b8afdf}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, {\bf uint32} {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_a5dcba2f939aaf5a1321546cc132fc26}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, {\bf int32} {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_0b39f730de828b78f3a70a5915cc695b}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, {\bf uint16} {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_3643837bb5d23453e69d2cf498d6b769}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, {\bf int16} {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_edee5c42e1b4f06384b90cf7e0a0c81e}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, {\bf uint8} {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_6ec8690b315a85a31b4fdf51c3b6b3f0}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, {\bf int8} {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_655e76f4e93233f74e747c14e01bd4c4}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, {\bf Base\-Object} const $\ast$ {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_72d5e7f8e285febf3839b006ca85d359}
\index{ost::Engine@{ost::Engine}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$<$$<$ ({\bf Engine} \& {\em ar}, {\bf Base\-Object} const \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_116ab36c3285ced5b7014fca2e59d6d1}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class x, class y$>$ {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, std::pair$<$ x, y $>$ \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_1a2e21651ff252fbbc8f804cc9de0466}
deserialize a pair of some serializable content to the engine. \index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Key, class Value$>$ {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, typename std::map$<$ Key, Value $>$ \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_b7c6902f8fc7840feb869c4a14da32d7}
deserialize a map with keys/values which both are serializeable from an engine. \index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, typename std::deque$<$ T $>$ \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_0fc218862af3cbe582ed446bd5e53f6f}
deserialize a deque of deserializable content from an engine. \index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, typename std::vector$<$ T $>$ \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_b55efd31c3b797101b1f3dfd3298f9b9}
deserialize a vector of deserializable content from an engine. \index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, bool \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_2304c8ac5d5bc806ea181a93ddc0c613}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, std::string \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_54979a11c9556c9064453c9470d9be9c}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, {\bf String} \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_3ab87cdc43b09dd3c55f627a79058716}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, double \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_c2a57112aec0833e1547b8b9daf5e2c1}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, float \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_379629479e4f02884e1a40e84f9fac4e}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, {\bf uint32} \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_57f63c9aa0c288dea64a04a22399b148}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, {\bf int32} \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_5e09520d31e0ea4d0293c1b6b3608a92}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, {\bf uint16} \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_e5d7eec0260dacd403e5346df95b59ca}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, {\bf int16} \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_dc3c04cb513208ac114a55622dadc399}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, {\bf uint8} \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_15f8363b519661cefed6de2e5bdd0dca}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, {\bf int8} \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_e802582363d270fd1fd711414b72579a}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, {\bf Base\-Object} $\ast$\& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_253975ae8ee3f3fcbec107f6bdfece9e}
\index{ost::Engine@{ost::Engine}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::Engine@{ost::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf Engine} \& operator$>$$>$ ({\bf Engine} \& {\em ar}, {\bf Base\-Object} \& {\em ob})\hspace{0.3cm}{\tt [related]}}\label{classost_1_1_engine_5b6de5b1c0193ecc4d58fc53b9b71b77}
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
{\bf persist.h}\end{CompactItemize}
