<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Engine class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.10 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>Engine Class Reference</h1>Engine stream serialization of persistent classes.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="persist_8h-source.html">persist.h</a>></code>
<p>
<a href="class_engine-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="class_engine.html#s2">EngineMode</a> { <a class="el" href="class_engine.html#s2s0">modeRead</a>,
<a class="el" href="class_engine.html#s2s1">modeWrite</a>
}</td></tr>
<tr><td> </td><td><font size=-1><em>These are the modes the Persistence::Engine can work in.</em> <a href="#s2">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_engine.html#a0">CCXX_MEMBER_EXPORT</a> (CCXX_EMPTY) Engine(std</td></tr>
<tr><td> </td><td><font size=-1><em>This Flushes the buffers and closes the Persistence::Engine this must happen before the underlying stream is shut down.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a1">Write</a> (uint8 i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a2">Write</a> (int16 i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a3">Write</a> (uint16 i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a4">Write</a> (int32 i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a5">Write</a> (uint32 i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a6">Write</a> (int64 i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a7">Write</a> (uint64 i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a8">Write</a> (float i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a9">Write</a> (double i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_engine.html#a10">CCXX_MEMBER_EXPORT</a> (void) Write(const std</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a11">Read</a> (uint8 &i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a12">Read</a> (int16 &i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a13">Read</a> (uint16 &i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a14">Read</a> (int32 &i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a15">Read</a> (uint32 &i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a16">Read</a> (int64 &i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a17">Read</a> (uint64 &i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a18">Read</a> (float &i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_engine.html#a19">Read</a> (double &i) THROWS(<a class="el" href="class_engine_1_1_exception.html">Exception</a>)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Engine stream serialization of persistent classes.
<p>
This class constructs on a standard C++ STL stream and then operates in the mode specified.
<p>
<dl compact><dt><b>
Author: </b><dd>
Daniel Silverstone </dl>
<p>
<hr><h2>Member Enumeration Documentation</h2>
<a name="s2" doxytag="Engine::EngineMode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum Engine::EngineMode
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
These are the modes the Persistence::Engine can work in.
<p>
<dl compact><dt><b>
Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="s2s0" doxytag="modeRead"></a><em>modeRead</em>
</em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="s2s1" doxytag="modeWrite"></a><em>modeWrite</em>
</em> </td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a10" doxytag="Engine::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Engine::CCXX_MEMBER_EXPORT </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a0" doxytag="Engine::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Engine::CCXX_MEMBER_EXPORT </td>
<td class="md">( </td>
<td class="md">CCXX_EMPTY</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
This Flushes the buffers and closes the Persistence::Engine this must happen before the underlying stream is shut down.
<p>
</td>
</tr>
</table>
<a name="a19" doxytag="Engine::Read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Read </td>
<td class="md">( </td>
<td class="md">double &</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a18" doxytag="Engine::Read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Read </td>
<td class="md">( </td>
<td class="md">float &</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a17" doxytag="Engine::Read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Read </td>
<td class="md">( </td>
<td class="md">uint64 &</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a16" doxytag="Engine::Read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Read </td>
<td class="md">( </td>
<td class="md">int64 &</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a15" doxytag="Engine::Read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Read </td>
<td class="md">( </td>
<td class="md">uint32 &</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a14" doxytag="Engine::Read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Read </td>
<td class="md">( </td>
<td class="md">int32 &</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a13" doxytag="Engine::Read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Read </td>
<td class="md">( </td>
<td class="md">uint16 &</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a12" doxytag="Engine::Read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Read </td>
<td class="md">( </td>
<td class="md">int16 &</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a11" doxytag="Engine::Read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Read </td>
<td class="md">( </td>
<td class="md">uint8 &</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a9" doxytag="Engine::Write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Write </td>
<td class="md">( </td>
<td class="md">double</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a8" doxytag="Engine::Write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Write </td>
<td class="md">( </td>
<td class="md">float</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a7" doxytag="Engine::Write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Write </td>
<td class="md">( </td>
<td class="md">uint64</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a6" doxytag="Engine::Write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Write </td>
<td class="md">( </td>
<td class="md">int64</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a5" doxytag="Engine::Write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Write </td>
<td class="md">( </td>
<td class="md">uint32</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a4" doxytag="Engine::Write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Write </td>
<td class="md">( </td>
<td class="md">int32</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="Engine::Write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Write </td>
<td class="md">( </td>
<td class="md">uint16</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a2" doxytag="Engine::Write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Write </td>
<td class="md">( </td>
<td class="md">int16</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="Engine::Write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Engine::Write </td>
<td class="md">( </td>
<td class="md">uint8</td>
<td class="mdname1"> <em>i</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="persist_8h-source.html">persist.h</a></ul>
<hr><address><small>Generated at Tue Nov 20 13:28:48 2001 for CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
68d373e54fb21da3730c08bede406633
>
files
>
149
