<!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>ucommon: ucommon/persist.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ucommon</div>
</td>
</tr>
</tbody>
</table>
</div>
<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>Data Structures</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>Globals</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00192.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<h1>ucommon/persist.h File Reference</h1> </div>
</div>
<div class="contents">
<p>The GNU Common C++ persistance engine by Daniel Silverstone.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include <ucommon/platform.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/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for persist.h:</div>
<div class="dyncontent">
<div class="center"><img src="a00238.png" border="0" usemap="#ucommon_2persist_8h" alt=""/></div>
<map name="ucommon_2persist_8h" id="ucommon_2persist_8h">
</map>
</div>
</div>
<p><a href="a00192_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html">PersistEngine</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stream serialization of persistent classes. <a href="a00105.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="a00106.html">PersistObject</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="a00106.html" title="PersistObject.">PersistObject</a>. <a href="a00106.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="a00166.html">TypeManager</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type manager for persistence engine. <a href="a00166.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="a00167.html">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 optimizers. <a href="a00167.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7df6645fae18e96d06803c9e110b5f15"></a><!-- doxytag: member="persist.h::CCXX_ENGINEREAD_REF" ref="a7df6645fae18e96d06803c9e110b5f15" args="(valref)" -->
#define </td><td class="memItemRight" valign="bottom"><b>CCXX_ENGINEREAD_REF</b>(valref)   readBinary((uint8_t*)&valref,sizeof(valref))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c0cd884a6ed71a178ef1569190c5e16"></a><!-- doxytag: member="persist.h::CCXX_ENGINEWRITE_REF" ref="a2c0cd884a6ed71a178ef1569190c5e16" args="(valref)" -->
#define </td><td class="memItemRight" valign="bottom"><b>CCXX_ENGINEWRITE_REF</b>(valref)   writeBinary((const uint8_t*)&valref,sizeof(valref))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adec91652f546e9365041e28d1a254fa8"></a><!-- doxytag: member="persist.h::CCXX_RE" ref="adec91652f546e9365041e28d1a254fa8" args="(ar, ob)" -->
#define </td><td class="memItemRight" valign="bottom"><b>CCXX_RE</b>(ar, ob)   ar.read(ob); return ar</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5adf584403ed6f629cf3dbf3b2974dd7"></a><!-- doxytag: member="persist.h::CCXX_WE" ref="a5adf584403ed6f629cf3dbf3b2974dd7" args="(ar, ob)" -->
#define </td><td class="memItemRight" valign="bottom"><b>CCXX_WE</b>(ar, ob)   ar.write(ob); return ar</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>DECLARE_PERSISTENCE</b>(ClassType)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>IMPLEMENT_PERSISTENCE</b>(ClassType, FullyQualifiedName)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a007a79d2deffc2a4a09bcce1943a6ecb"></a><!-- doxytag: member="persist.h::NS_PREFIX" ref="a007a79d2deffc2a4a09bcce1943a6ecb" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>NS_PREFIX</b>   ucc::</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0283a52f5431d60599ff115a53586df"></a><!-- doxytag: member="persist.h::NewPersistObjectFunction" ref="aa0283a52f5431d60599ff115a53586df" args=")(void)" -->
typedef class <a class="el" href="a00106.html">PersistObject</a> *(* </td><td class="memItemRight" valign="bottom"><b>NewPersistObjectFunction</b> )(void)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The GNU Common C++ persistance engine by Daniel Silverstone. </p>
<p>Definition in file <a class="el" href="a00192_source.html">persist.h</a>.</p>
</div><hr/><h2>Define Documentation</h2>
<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"> </td>
<td class="paramname">ClassType</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> NS_PREFIX <a class="code" href="a00105.html" title="Stream serialization of persistent classes.">PersistEngine</a>& <a class="code" href="a00105.html#a8eab0795c1b902f5f32ba5b710127865">operator>></a>( NS_PREFIX <a class="code" href="a00105.html" title="Stream serialization of persistent classes.">PersistEngine</a>& ar, ClassType *&ob); \
<span class="keyword">friend</span> NS_PREFIX <a class="code" href="a00105.html" title="Stream serialization of persistent classes.">PersistEngine</a>& <a class="code" href="a00105.html#afba84e3fdb2f3beccc82199eddee184f">operator<<</a>( NS_PREFIX <a class="code" href="a00105.html" title="Stream serialization of persistent classes.">PersistEngine</a>& ar, ClassType <span class="keyword">const</span> &ob); \
<span class="keyword">friend</span> NS_PREFIX <a class="code" href="a00106.html" title="PersistObject.">PersistObject</a> *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> NS_PREFIX TypeManager::Registration registrationFor##ClassType;
</pre></div>
<p>Definition at line <a class="el" href="a00192_source.html#l00105">105</a> of file <a class="el" href="a00192_source.html">persist.h</a>.</p>
</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"> </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"><pre class="fragment">NS_PREFIX <a class="code" href="a00106.html" title="PersistObject.">PersistObject</a> *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;} \
NS_PREFIX <a class="code" href="a00105.html" title="Stream serialization of persistent classes.">PersistEngine</a>& <a class="code" href="a00105.html#a8eab0795c1b902f5f32ba5b710127865">operator>></a>(NS_PREFIX <a class="code" href="a00105.html" title="Stream serialization of persistent classes.">PersistEngine</a>& ar, ClassType &ob) \
{ ar >> (NS_PREFIX <a class="code" href="a00106.html" title="PersistObject.">PersistObject</a> &) ob; <span class="keywordflow">return</span> ar; } \
NS_PREFIX <a class="code" href="a00105.html" title="Stream serialization of persistent classes.">PersistEngine</a>& <a class="code" href="a00105.html#a8eab0795c1b902f5f32ba5b710127865">operator>></a>(NS_PREFIX <a class="code" href="a00105.html" title="Stream serialization of persistent classes.">PersistEngine</a>& ar, ClassType *&ob) \
{ ar >> (NS_PREFIX <a class="code" href="a00106.html" title="PersistObject.">PersistObject</a> *&) ob; <span class="keywordflow">return</span> ar; } \
NS_PREFIX <a class="code" href="a00105.html" title="Stream serialization of persistent classes.">PersistEngine</a>& <a class="code" href="a00105.html#afba84e3fdb2f3beccc82199eddee184f">operator<<</a>(NS_PREFIX <a class="code" href="a00105.html" title="Stream serialization of persistent classes.">PersistEngine</a>& ar, ClassType <span class="keyword">const</span> &ob) \
{ ar << (NS_PREFIX <a class="code" href="a00106.html" title="PersistObject.">PersistObject</a> <span class="keyword">const</span> *)&ob; <span class="keywordflow">return</span> ar; } \
NS_PREFIX TypeManager::Registration \
ClassType::registrationFor##ClassType(FullyQualifiedName, \
createNew##ClassType);
</pre></div>
<p>Definition at line <a class="el" href="a00192_source.html#l00113">113</a> of file <a class="el" href="a00192_source.html">persist.h</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00192.html">persist.h</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:47 for ucommon by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
