<!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: PersistObject Class 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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><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="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</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('a00106.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>PersistObject Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="PersistObject" -->
<p><a class="el" href="a00106.html" title="PersistObject.">PersistObject</a>.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00192_source.html">persist.h</a>></code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cc42b3d8e8d9f5ff8bc18f9c03199a5"></a><!-- doxytag: member="PersistObject::getPersistenceID" ref="a0cc42b3d8e8d9f5ff8bc18f9c03199a5" args="() const " -->
virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a0cc42b3d8e8d9f5ff8bc18f9c03199a5">getPersistenceID</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This returns the ID of the persistent object (Its type) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#af76c44c2baec1f17405991b1cf753da7">PersistObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This constructor is used in serialization processes. <a href="#af76c44c2baec1f17405991b1cf753da7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81188ffa62e6088f971dcccf8dd0c044"></a><!-- doxytag: member="PersistObject::read" ref="a81188ffa62e6088f971dcccf8dd0c044" args="(PersistEngine &archive)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a81188ffa62e6088f971dcccf8dd0c044">read</a> (<a class="el" href="a00105.html">PersistEngine</a> &archive)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is used to read from a Persistence::Engine It is not equivalent to the >> operator as it does no typesafety or anything. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a893d35eb1e3700d2761eea5d4382e0de"></a><!-- doxytag: member="PersistObject::write" ref="a893d35eb1e3700d2761eea5d4382e0de" args="(PersistEngine &archive) const " -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a893d35eb1e3700d2761eea5d4382e0de">write</a> (<a class="el" href="a00105.html">PersistEngine</a> &archive) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is used to write to the Persistence::Engine It is not equivalent to the << operator as it writes only the data and not the object type etc. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a939c73a48a52c23ba0b496d8247e7f"></a><!-- doxytag: member="PersistObject::~PersistObject" ref="a5a939c73a48a52c23ba0b496d8247e7f" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a5a939c73a48a52c23ba0b496d8247e7f">~PersistObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="a00106.html" title="PersistObject.">PersistObject</a>. </p>
<p>Base class for classes that will be persistent. This object is the base for all Persistent data which is not natively serialized by the persistence::engine</p>
<p>It registers itself with the persistence::TypeManager using a global constructor function. A matching deregister call is made in a global destructor, to allow DLL's to use the persistence::engine in a main executable.</p>
<p>Persistable objects must never maintain bad pointers. If a pointer doesn't point to something valid, it must be NULL. This is so the persistence engine knows whether to allocate memory for an object or whether the memory has been pre-allocated.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Daniel Silverstone </dd></dl>
<p>Definition at line <a class="el" href="a00192_source.html#l00147">147</a> of file <a class="el" href="a00192_source.html">persist.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af76c44c2baec1f17405991b1cf753da7"></a><!-- doxytag: member="PersistObject::PersistObject" ref="af76c44c2baec1f17405991b1cf753da7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PersistObject::PersistObject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This constructor is used in serialization processes. </p>
<p>It is called in CreateNewInstance in order to create an instance of the class to have Read() called on it. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00192_source.html">persist.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00106.html">PersistObject</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:48 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>
