<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::BaseObject Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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 class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_base_object.html">BaseObject</a></div>
<h1>ost::BaseObject Class Reference</h1><!-- doxytag: class="ost::BaseObject" -->BaseObjectBase class for classes that will be persistent.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="persist_8h-source.html">persist.h</a>></code>
<p>
<a href="classost_1_1_base_object-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_base_object.html#5c82b7bc43a0860b394d10f16facb840">BaseObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This constructor is used in serialisation processes. <a href="#5c82b7bc43a0860b394d10f16facb840"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_base_object.html#d525c478d9de4a2f4f509aecb6762f05">~BaseObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#d525c478d9de4a2f4f509aecb6762f05"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_base_object.html#018e6d811703fe0eee6caaff9e0bdd0e">getPersistenceID</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This returns the ID of the persistent object (Its type). <a href="#018e6d811703fe0eee6caaff9e0bdd0e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_base_object.html#97719386fd53d191444ee34933f9c42b">write</a> (<a class="el" href="classost_1_1_engine.html">Engine</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. <a href="#97719386fd53d191444ee34933f9c42b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_base_object.html#7334c7573cdee399d7d17be956ef2f48">read</a> (<a class="el" href="classost_1_1_engine.html">Engine</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. <a href="#7334c7573cdee399d7d17be956ef2f48"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
BaseObjectBase class for classes that will be persistent.
<p>
This object is the base for all Persistent data which is not natively serialised by the Persistence::Engine<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>
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 compact><dt><b>Author:</b></dt><dd>Daniel Silverstone </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="5c82b7bc43a0860b394d10f16facb840"></a><!-- doxytag: member="ost::BaseObject::BaseObject" ref="5c82b7bc43a0860b394d10f16facb840" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::BaseObject::BaseObject </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This constructor is used in serialisation processes.
<p>
It is called in CreateNewInstance in order to create an instance of the class to have Read() called on it. </td>
</tr>
</table>
<a class="anchor" name="d525c478d9de4a2f4f509aecb6762f05"></a><!-- doxytag: member="ost::BaseObject::~BaseObject" ref="d525c478d9de4a2f4f509aecb6762f05" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::BaseObject::~BaseObject </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Default destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="018e6d811703fe0eee6caaff9e0bdd0e"></a><!-- doxytag: member="ost::BaseObject::getPersistenceID" ref="018e6d811703fe0eee6caaff9e0bdd0e" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual const char* ost::BaseObject::getPersistenceID </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This returns the ID of the persistent object (Its type).
<p>
</td>
</tr>
</table>
<a class="anchor" name="7334c7573cdee399d7d17be956ef2f48"></a><!-- doxytag: member="ost::BaseObject::read" ref="7334c7573cdee399d7d17be956ef2f48" args="(Engine &archive)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual bool ost::BaseObject::read </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_engine.html">Engine</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>archive</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<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>
</td>
</tr>
</table>
<a class="anchor" name="97719386fd53d191444ee34933f9c42b"></a><!-- doxytag: member="ost::BaseObject::write" ref="97719386fd53d191444ee34933f9c42b" args="(Engine &archive) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual bool ost::BaseObject::write </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_engine.html">Engine</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>archive</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<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>
</td>
</tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
