<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>GNU CommonC++: persist.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <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="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</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> </div> <div class="contents"> <h1>persist.h File Reference</h1> <p>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 <zlib.h></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></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Classes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_persist_exception.html">ost::PersistException</a></td></tr> <tr><td class="memItemLeft" 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. <a href="classost_1_1_type_manager.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" 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" 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"><a class="el" href="classost_1_1_base_object.html" title="BaseObject.">BaseObject</a>. <a href="classost_1_1_base_object.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" 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"><a class="el" href="classost_1_1_engine.html" title="Engine.">Engine</a>. <a href="classost_1_1_engine.html#_details">More...</a><br/></td></tr> <tr><td colspan="2"><h2>Namespaces</h2></td></tr> <tr><td class="memItemLeft" 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"><h2>Defines</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> ost::</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="persist_8h.html#a0063bc0eb4e47f3fd4b0662d31656838">DECLARE_PERSISTENCE</a>(ClassType)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="persist_8h.html#a518a5354fd7cb859b9534d7806cc883c">IMPLEMENT_PERSISTENCE</a>(ClassType, FullyQualifiedName)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="persist_8h.html#a2c0cd884a6ed71a178ef1569190c5e16">CCXX_ENGINEWRITE_REF</a>(valref) writeBinary((const <a class="el" href="config_8h.html#a2f658db822f8a23711b5bac1094c2185">uint8</a>*)&valref,sizeof(valref))</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="persist_8h.html#a7df6645fae18e96d06803c9e110b5f15">CCXX_ENGINEREAD_REF</a>(valref) readBinary((<a class="el" href="config_8h.html#a2f658db822f8a23711b5bac1094c2185">uint8</a>*)&valref,sizeof(valref))</td></tr> <tr><td colspan="2"><h2>Typedefs</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef class BaseObject *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#abaf4b8bd869b80b3711d0d84f5b91ac5">ost::NewBaseObjectFunction</a> )(void)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Persistence library classes. </p> <hr/><h2>Define Documentation</h2> <a class="anchor" id="a7df6645fae18e96d06803c9e110b5f15"></a><!-- doxytag: member="persist.h::CCXX_ENGINEREAD_REF" ref="a7df6645fae18e96d06803c9e110b5f15" args="(valref)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define CCXX_ENGINEREAD_REF</td> <td>(</td> <td class="paramtype">valref </td> <td class="paramname"></td> <td> ) </td> <td> readBinary((<a class="el" href="config_8h.html#a2f658db822f8a23711b5bac1094c2185">uint8</a>*)&valref,sizeof(valref))</td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="persist_8h_source.html#l00337">ost::Engine::read()</a>.</p> </div> </div> <a class="anchor" id="a2c0cd884a6ed71a178ef1569190c5e16"></a><!-- doxytag: member="persist.h::CCXX_ENGINEWRITE_REF" ref="a2c0cd884a6ed71a178ef1569190c5e16" args="(valref)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define CCXX_ENGINEWRITE_REF</td> <td>(</td> <td class="paramtype">valref </td> <td class="paramname"></td> <td> ) </td> <td> writeBinary((const <a class="el" href="config_8h.html#a2f658db822f8a23711b5bac1094c2185">uint8</a>*)&valref,sizeof(valref))</td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="persist_8h_source.html#l00301">ost::Engine::write()</a>.</p> </div> </div> <a class="anchor" id="a0063bc0eb4e47f3fd4b0662d31656838"></a><!-- doxytag: member="persist.h::DECLARE_PERSISTENCE" ref="a0063bc0eb4e47f3fd4b0662d31656838" args="(ClassType)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define DECLARE_PERSISTENCE</td> <td>(</td> <td class="paramtype">ClassType </td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <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#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& operator>>( <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType *&ob); \ <span class="keyword">friend</span> <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& <a class="code" href="namespaceost.html#a43b65f3c2266eb63ba22c1ff73a6e20b">operator<<</a>( <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType <span class="keyword">const</span> &ob); \ <span class="keyword">friend</span> <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">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#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> TypeManager::Registration registrationFor##ClassType; </pre></div> </div> </div> <a class="anchor" id="a518a5354fd7cb859b9534d7806cc883c"></a><!-- doxytag: member="persist.h::IMPLEMENT_PERSISTENCE" ref="a518a5354fd7cb859b9534d7806cc883c" args="(ClassType, FullyQualifiedName)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define IMPLEMENT_PERSISTENCE</td> <td>(</td> <td class="paramtype">ClassType, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">FullyQualifiedName </td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">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#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& operator>>(<a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType &ob) \ { ar >> (<a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> BaseObject &) ob; <span class="keywordflow">return</span> ar; } \ <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& operator>>(<a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType *&ob) \ { ar >> (<a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> BaseObject *&) ob; <span class="keywordflow">return</span> ar; } \ <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& <a class="code" href="namespaceost.html#a43b65f3c2266eb63ba22c1ff73a6e20b">operator<<</a>(<a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType <span class="keyword">const</span> &ob) \ { ar << (<a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> BaseObject <span class="keyword">const</span> *)&ob; <span class="keywordflow">return</span> ar; } \ <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> TypeManager::Registration \ ClassType::registrationFor##ClassType(FullyQualifiedName, \ createNew##ClassType); </pre></div> </div> </div> <a class="anchor" id="a007a79d2deffc2a4a09bcce1943a6ecb"></a><!-- doxytag: member="persist.h::NS_PREFIX" ref="a007a79d2deffc2a4a09bcce1943a6ecb" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define NS_PREFIX ost::</td> </tr> </table> </div> <div class="memdoc"> </div> </div> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:46 2010 for GNU CommonC++ by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>