<!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++: ost::BaseObject Class 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 class="current"><a href="annotated.html"><span>Classes</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>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_base_object.html">BaseObject</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classost_1_1_base_object-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::BaseObject Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><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></p>
<p><code>#include <<a class="el" href="persist_8h_source.html">persist.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5c82b7bc43a0860b394d10f16facb840"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_base_object.html#a5c82b7bc43a0860b394d10f16facb840">BaseObject</a> ()</td></tr>
<tr class="memdesc:a5c82b7bc43a0860b394d10f16facb840"><td class="mdescLeft"> </td><td class="mdescRight">This constructor is used in serialisation processes. <a href="#a5c82b7bc43a0860b394d10f16facb840">More...</a><br/></td></tr>
<tr class="separator:a5c82b7bc43a0860b394d10f16facb840"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad525c478d9de4a2f4f509aecb6762f05"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_base_object.html#ad525c478d9de4a2f4f509aecb6762f05">~BaseObject</a> ()</td></tr>
<tr class="memdesc:ad525c478d9de4a2f4f509aecb6762f05"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#ad525c478d9de4a2f4f509aecb6762f05">More...</a><br/></td></tr>
<tr class="separator:ad525c478d9de4a2f4f509aecb6762f05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a018e6d811703fe0eee6caaff9e0bdd0e"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_base_object.html#a018e6d811703fe0eee6caaff9e0bdd0e">getPersistenceID</a> () const </td></tr>
<tr class="memdesc:a018e6d811703fe0eee6caaff9e0bdd0e"><td class="mdescLeft"> </td><td class="mdescRight">This returns the ID of the persistent object (Its type) <a href="#a018e6d811703fe0eee6caaff9e0bdd0e">More...</a><br/></td></tr>
<tr class="separator:a018e6d811703fe0eee6caaff9e0bdd0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97719386fd53d191444ee34933f9c42b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_base_object.html#a97719386fd53d191444ee34933f9c42b">write</a> (<a class="el" href="classost_1_1_engine.html">Engine</a> &archive) const </td></tr>
<tr class="memdesc:a97719386fd53d191444ee34933f9c42b"><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. <a href="#a97719386fd53d191444ee34933f9c42b">More...</a><br/></td></tr>
<tr class="separator:a97719386fd53d191444ee34933f9c42b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7334c7573cdee399d7d17be956ef2f48"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_base_object.html#a7334c7573cdee399d7d17be956ef2f48">read</a> (<a class="el" href="classost_1_1_engine.html">Engine</a> &archive)</td></tr>
<tr class="memdesc:a7334c7573cdee399d7d17be956ef2f48"><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. <a href="#a7334c7573cdee399d7d17be956ef2f48">More...</a><br/></td></tr>
<tr class="separator:a7334c7573cdee399d7d17be956ef2f48"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classost_1_1_base_object.html" title="BaseObject. ">BaseObject</a>. </p>
<p>This object is the base for all Persistent data which is not natively serialised 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="section author"><dt>Author</dt><dd>Daniel Silverstone Base class for classes that will be persistent. </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5c82b7bc43a0860b394d10f16facb840"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::BaseObject::BaseObject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This constructor is used in serialisation 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>
<a class="anchor" id="ad525c478d9de4a2f4f509aecb6762f05"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ost::BaseObject::~BaseObject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a018e6d811703fe0eee6caaff9e0bdd0e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* ost::BaseObject::getPersistenceID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This returns the ID of the persistent object (Its type) </p>
</div>
</div>
<a class="anchor" id="a7334c7573cdee399d7d17be956ef2f48"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ost::BaseObject::read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_engine.html">Engine</a> & </td>
<td class="paramname"><em>archive</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is used to read from a Persistence::Engine It is not equivalent to the >> operator as it does no typesafety or anything. </p>
</div>
</div>
<a class="anchor" id="a97719386fd53d191444ee34933f9c42b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ost::BaseObject::write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_engine.html">Engine</a> & </td>
<td class="paramname"><em>archive</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>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. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="persist_8h_source.html">persist.h</a></li>
</ul>
</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>
