<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GNU CommonC++: persist.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU CommonC++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><a class="el" href="dir_6b3e09e31d3da6038137f0238e9fb19b.html">cc++</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#namespaces">Namespaces</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">persist.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Persistence library classes.
<a href="#details">More...</a></p>
<div class="textblock"><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/>
</div>
<p><a href="persist_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceost"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html">ost</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:add94524a0409d3308ec901d8917f88b3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="persist_8h.html#add94524a0409d3308ec901d8917f88b3">NO_COMPRESSION</a></td></tr>
<tr class="separator:add94524a0409d3308ec901d8917f88b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a007a79d2deffc2a4a09bcce1943a6ecb"><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 class="separator:a007a79d2deffc2a4a09bcce1943a6ecb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0063bc0eb4e47f3fd4b0662d31656838"><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 class="separator:a0063bc0eb4e47f3fd4b0662d31656838"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a518a5354fd7cb859b9534d7806cc883c"><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 class="separator:a518a5354fd7cb859b9534d7806cc883c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c0cd884a6ed71a178ef1569190c5e16"><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 class="separator:a2c0cd884a6ed71a178ef1569190c5e16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7df6645fae18e96d06803c9e110b5f15"><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 class="separator:a7df6645fae18e96d06803c9e110b5f15"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:abaf4b8bd869b80b3711d0d84f5b91ac5"><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>
<tr class="separator:abaf4b8bd869b80b3711d0d84f5b91ac5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Persistence library classes. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a7df6645fae18e96d06803c9e110b5f15"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CCXX_ENGINEREAD_REF</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">valref</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="classost_1_1_engine.html#ac3f4e91e6bf01957937399af29048da3">ost::Engine::read()</a>.</p>
</div>
</div>
<a class="anchor" id="a2c0cd884a6ed71a178ef1569190c5e16"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CCXX_ENGINEWRITE_REF</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">valref</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="classost_1_1_engine.html#af4aa5f27b2e837e38de4f99de63a8ff2">ost::Engine::write()</a>.</p>
</div>
</div>
<a class="anchor" id="a0063bc0eb4e47f3fd4b0662d31656838"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DECLARE_PERSISTENCE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">ClassType</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">public</span>: \</div>
<div class="line"> friend <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& <a class="code" href="classost_1_1_engine.html#a5b6de5b1c0193ecc4d58fc53b9b71b77">operator>></a>( <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType *&ob); \</div>
<div class="line"> friend <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& <a class="code" href="classost_1_1_engine.html#a116ab36c3285ced5b7014fca2e59d6d1">operator<<</a>( <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType <span class="keyword">const</span> &ob); \</div>
<div class="line"> friend <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> BaseObject *createNew##ClassType(); \</div>
<div class="line"> virtual <span class="keyword">const</span> <span class="keywordtype">char</span>* getPersistenceID() <span class="keyword">const</span>; \</div>
<div class="line"> static <a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> TypeManager::Registration registrationFor##ClassType;</div>
<div class="ttc" id="classost_1_1_engine_html_a5b6de5b1c0193ecc4d58fc53b9b71b77"><div class="ttname"><a href="classost_1_1_engine.html#a5b6de5b1c0193ecc4d58fc53b9b71b77">ost::Engine::operator>></a></div><div class="ttdeci">__EXPORT Engine & operator>>(Engine &ar, BaseObject &ob) THROWS(PersistException)</div></div>
<div class="ttc" id="persist_8h_html_a007a79d2deffc2a4a09bcce1943a6ecb"><div class="ttname"><a href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a></div><div class="ttdeci">#define NS_PREFIX</div><div class="ttdef"><b>Definition:</b> persist.h:79</div></div>
<div class="ttc" id="classost_1_1_engine_html_a116ab36c3285ced5b7014fca2e59d6d1"><div class="ttname"><a href="classost_1_1_engine.html#a116ab36c3285ced5b7014fca2e59d6d1">ost::Engine::operator<<</a></div><div class="ttdeci">__EXPORT Engine & operator<<(Engine &ar, BaseObject const &ob) THROWS(PersistException)</div></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="a518a5354fd7cb859b9534d7806cc883c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define IMPLEMENT_PERSISTENCE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">ClassType, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">FullyQualifiedName </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><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; } \</div>
<div class="line"> const <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">\</a></div>
<div class="line"><a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb"> NS_PREFIX</a> Engine& <a class="code" href="classost_1_1_engine.html#a5b6de5b1c0193ecc4d58fc53b9b71b77">operator>></a>(<a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType &ob) \</div>
<div class="line"> { 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">\</a></div>
<div class="line"><a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb"> NS_PREFIX</a> Engine& <a class="code" href="classost_1_1_engine.html#a5b6de5b1c0193ecc4d58fc53b9b71b77">operator>></a>(<a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType *&ob) \</div>
<div class="line"> { 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">\</a></div>
<div class="line"><a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb"> NS_PREFIX</a> Engine& <a class="code" href="classost_1_1_engine.html#a116ab36c3285ced5b7014fca2e59d6d1">operator<<</a>(<a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a> Engine& ar, ClassType <span class="keyword">const</span> &ob) \</div>
<div class="line"> { 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">\</a></div>
<div class="line"><a class="code" href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb"> NS_PREFIX</a> TypeManager::Registration \</div>
<div class="line"> ClassType::registrationFor##ClassType(FullyQualifiedName, \</div>
<div class="line"> createNew##ClassType);</div>
<div class="ttc" id="classost_1_1_engine_html_a5b6de5b1c0193ecc4d58fc53b9b71b77"><div class="ttname"><a href="classost_1_1_engine.html#a5b6de5b1c0193ecc4d58fc53b9b71b77">ost::Engine::operator>></a></div><div class="ttdeci">__EXPORT Engine & operator>>(Engine &ar, BaseObject &ob) THROWS(PersistException)</div></div>
<div class="ttc" id="persist_8h_html_a007a79d2deffc2a4a09bcce1943a6ecb"><div class="ttname"><a href="persist_8h.html#a007a79d2deffc2a4a09bcce1943a6ecb">NS_PREFIX</a></div><div class="ttdeci">#define NS_PREFIX</div><div class="ttdef"><b>Definition:</b> persist.h:79</div></div>
<div class="ttc" id="classost_1_1_engine_html_a116ab36c3285ced5b7014fca2e59d6d1"><div class="ttname"><a href="classost_1_1_engine.html#a116ab36c3285ced5b7014fca2e59d6d1">ost::Engine::operator<<</a></div><div class="ttdeci">__EXPORT Engine & operator<<(Engine &ar, BaseObject const &ob) THROWS(PersistException)</div></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="add94524a0409d3308ec901d8917f88b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NO_COMPRESSION</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a007a79d2deffc2a4a09bcce1943a6ecb"></a>
<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><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 23:24:57 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
