<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: persist.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul></div>
<h1>persist.h File Reference</h1>Persistence library classes. <a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="config_8h-source.html">cc++/config.h</a>></code><br>
<code>#include <<a class="el" href="exception_8h-source.html">cc++/exception.h</a>></code><br>
<code>#include <<a class="el" href="missing_8h-source.html">cc++/missing.h</a>></code><br>
<code>#include <<a class="el" href="string_8h-source.html">cc++/string.h</a>></code><br>
<code>#include <iostream></code><br>
<code>#include <string></code><br>
<code>#include <vector></code><br>
<code>#include <deque></code><br>
<code>#include <map></code><br>
<p>
<a href="persist_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html">ost</a></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_type_manager.html">ost::TypeManager</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This class manages the types for generation of the persistent objects.Type manager for persistence engine. <a href="classost_1_1_type_manager.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_type_manager_1_1_registration.html">ost::TypeManager::Registration</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This manages a registration to the typemanager - attempting to remove problems with the optimisers. <a href="classost_1_1_type_manager_1_1_registration.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_base_object.html">ost::BaseObject</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">BaseObjectBase class for classes that will be persistent. <a href="classost_1_1_base_object.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_engine.html">ost::Engine</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enginestream serialization of persistent classes. <a href="classost_1_1_engine.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="persist_8h.html#dd94524a0409d3308ec901d8917f88b3">NO_COMPRESSION</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> ost::</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="persist_8h.html#0063bc0eb4e47f3fd4b0662d31656838">DECLARE_PERSISTENCE</a>(ClassType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="persist_8h.html#518a5354fd7cb859b9534d7806cc883c">IMPLEMENT_PERSISTENCE</a>(ClassType, FullyQualifiedName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="persist_8h.html#2c0cd884a6ed71a178ef1569190c5e16">CCXX_ENGINEWRITE_REF</a>(valref) writeBinary((const <a class="el" href="config_8h.html#2f658db822f8a23711b5bac1094c2185">uint8</a>*)&valref,sizeof(valref))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="persist_8h.html#7df6645fae18e96d06803c9e110b5f15">CCXX_ENGINEREAD_REF</a>(valref) readBinary((<a class="el" href="config_8h.html#2f658db822f8a23711b5bac1094c2185">uint8</a>*)&valref,sizeof(valref))</td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef BaseObject *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#baf4b8bd869b80b3711d0d84f5b91ac5">ost::NewBaseObjectFunction</a> )(void)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Persistence library classes.
<p>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="7df6645fae18e96d06803c9e110b5f15"></a><!-- doxytag: member="persist.h::CCXX_ENGINEREAD_REF" ref="7df6645fae18e96d06803c9e110b5f15" args="(valref)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define CCXX_ENGINEREAD_REF </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">valref </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> readBinary((<a class="el" href="config_8h.html#2f658db822f8a23711b5bac1094c2185">uint8</a>*)&valref,sizeof(valref))</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="2c0cd884a6ed71a178ef1569190c5e16"></a><!-- doxytag: member="persist.h::CCXX_ENGINEWRITE_REF" ref="2c0cd884a6ed71a178ef1569190c5e16" args="(valref)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define CCXX_ENGINEWRITE_REF </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">valref </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> writeBinary((const <a class="el" href="config_8h.html#2f658db822f8a23711b5bac1094c2185">uint8</a>*)&valref,sizeof(valref))</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="0063bc0eb4e47f3fd4b0662d31656838"></a><!-- doxytag: member="persist.h::DECLARE_PERSISTENCE" ref="0063bc0eb4e47f3fd4b0662d31656838" args="(ClassType)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define DECLARE_PERSISTENCE </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">ClassType </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keyword">public</span>: \
<span class="keyword">friend</span> <a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& operator>>( <a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType *&ob); \
<span class="keyword">friend</span> <a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& <a class="code" href="namespaceost.html#43b65f3c2266eb63ba22c1ff73a6e20b">operator<<</a>( <a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType <span class="keyword">const</span> &ob); \
<span class="keyword">friend</span> <a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> BaseObject *createNew##ClassType(); \
<span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* getPersistenceID() <span class="keyword">const</span>; \
<span class="keyword">static</span> <a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> TypeManager::Registration registrationFor##ClassType;
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="518a5354fd7cb859b9534d7806cc883c"></a><!-- doxytag: member="persist.h::IMPLEMENT_PERSISTENCE" ref="518a5354fd7cb859b9534d7806cc883c" args="(ClassType, FullyQualifiedName)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define IMPLEMENT_PERSISTENCE </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">ClassType, <tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>FullyQualifiedName </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> BaseObject *createNew##ClassType() { <span class="keywordflow">return</span> <span class="keyword">new</span> ClassType; } \
<span class="keyword">const</span> <span class="keywordtype">char</span>* ClassType::getPersistenceID()<span class="keyword"> const </span>{<span class="keywordflow">return</span> FullyQualifiedName;} \
<a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& operator>>(<a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType &ob) \
{ ar >> (<a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> BaseObject &) ob; <span class="keywordflow">return</span> ar; } \
<a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& operator>>(<a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType *&ob) \
{ ar >> (<a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> BaseObject *&) ob; <span class="keywordflow">return</span> ar; } \
<a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& <a class="code" href="namespaceost.html#43b65f3c2266eb63ba22c1ff73a6e20b">operator<<</a>(<a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType <span class="keyword">const</span> &ob) \
{ ar << (<a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> BaseObject <span class="keyword">const</span> *)&ob; <span class="keywordflow">return</span> ar; } \
<a class="code" href="persist_8h.html#007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> TypeManager::Registration \
ClassType::registrationFor##ClassType(FullyQualifiedName, \
createNew##ClassType);
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="dd94524a0409d3308ec901d8917f88b3"></a><!-- doxytag: member="persist.h::NO_COMPRESSION" ref="dd94524a0409d3308ec901d8917f88b3" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define NO_COMPRESSION </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="007a79d2deffc2a4a09bcce1943a6ecb"></a><!-- doxytag: member="persist.h::NS_PREFIX" ref="007a79d2deffc2a4a09bcce1943a6ecb" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define NS_PREFIX ost:: </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:55 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
