<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>ost::BaseObject class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body bgcolor="#ffffff"> <!-- Generated by Doxygen 1.2.10 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>ost::BaseObject Class Reference</h1><a class="el" href="classost_1_1_base_object.html">BaseObject</a> Base 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 colspan=2><br><h2>Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classost_1_1_base_object.html#a0">BaseObject</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>This constructor is used in serialisation processes.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classost_1_1_base_object.html#a1">~BaseObject</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Default destructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="classost_1_1_base_object.html#a2">GetPersistenceID</a> () const</td></tr> <tr><td> </td><td><font size=-1><em>This returns the ID of the persistent object (Its type).</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classost_1_1_base_object.html#a3">Write</a> (<a class="el" href="classost_1_1_engine.html">Engine</a> &archive) const</td></tr> <tr><td> </td><td><font size=-1><em>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.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classost_1_1_base_object.html#a4">Read</a> (<a class="el" href="classost_1_1_engine.html">Engine</a> &archive)</td></tr> <tr><td> </td><td><font size=-1><em>This method is used to read from a Persistence::Engine It is not equivalent to the >> operator as it does no typesafety or anything.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <a class="el" href="classost_1_1_base_object.html">BaseObject</a> Base 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> <dl compact><dt><b> Author: </b><dd> Daniel Silverstone </dl> <p> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="ost::BaseObject::BaseObject"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> ost::BaseObject::BaseObject </td> <td class="md">( </td> <td class="mdname1"> </td> <td class="md">) </td> <td class="md"></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 <a class="el" href="classost_1_1_base_object.html#a4">Read</a>() called on it. </td> </tr> </table> <a name="a1" doxytag="ost::BaseObject::~BaseObject"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual ost::BaseObject::~BaseObject </td> <td class="md">( </td> <td class="mdname1"> </td> <td class="md">) </td> <td class="md"><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 name="a2" doxytag="ost::BaseObject::GetPersistenceID"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual const char* ost::BaseObject::GetPersistenceID </td> <td class="md">( </td> <td class="mdname1"> </td> <td class="md">) </td> <td class="md"> 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 name="a4" doxytag="ost::BaseObject::Read"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual bool ost::BaseObject::Read </td> <td class="md">( </td> <td class="md"><a class="el" href="classost_1_1_engine.html">Engine</a> &</td> <td class="mdname1"> <em>archive</em> </td> <td class="md">) </td> <td class="md"><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 name="a3" doxytag="ost::BaseObject::Write"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual bool ost::BaseObject::Write </td> <td class="md">( </td> <td class="md"><a class="el" href="classost_1_1_engine.html">Engine</a> &</td> <td class="mdname1"> <em>archive</em> </td> <td class="md">) </td> <td class="md"> 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><address><small>Generated at Fri Jan 4 18:51:47 2002 for CommonC++ by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.gif" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2001</small></address> </body> </html>