<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>BaseObject class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.5 on Thu Oct 4 15:32:59 2001 -->
<center>
<a class="qindex" href="index.html">Main Page</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="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>BaseObject Class Reference</h1>BaseObject Base class for classes that will be persistent.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="persist_h-source.html">persist.h</a>></code>
<p>
<p>Inheritance diagram for BaseObject:
<p><center><img src="class_baseobject.gif" usemap="#BaseObject_map" border="0"></center>
<map name="BaseObject_map">
<area href="class_entity.html" alt="Entity" shape="rect" coords="112,56,214,80">
<area href="class_body.html" alt="Body" shape="rect" coords="0,112,102,136">
<area href="class_head.html" alt="Head" shape="rect" coords="112,112,214,136">
<area href="class_htmldocument.html" alt="HTMLDocument" shape="rect" coords="224,112,326,136">
<area href="class_frameset.html" alt="Frameset" shape="rect" coords="0,168,102,192">
</map>
<a href="class_baseobject-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="class_baseobject.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="class_baseobject.html#a1">~BaseObject</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Default destructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_baseobject.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></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="config_h.html#a17">bool</a> </td><td valign=bottom><a class="el" href="class_baseobject.html#a3">Write</a> (<a class="el" href="class_engine.html">Engine</a> &archive) const</td></tr>
<tr><td> </td><td><font size=-1><em>This method is used to write to the <a class="el" href="persist_h.html#a1">Persistence::Engine</a> It is not equivalent to the << operator as it writes only the data and not the object type etc.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="config_h.html#a17">bool</a> </td><td valign=bottom><a class="el" href="class_baseobject.html#a4">Read</a> (<a class="el" href="class_engine.html">Engine</a> &archive)</td></tr>
<tr><td> </td><td><font size=-1><em>This method is used to read from a <a class="el" href="persist_h.html#a1">Persistence::Engine</a> It is not equivalent to the >> operator as it does no typesafety or anything.</em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
BaseObject 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 <a class="el" href="persist_h.html#a1">Persistence::Engine</a>
<p>
It registers itself with the <a class="el" href="persist_h.html#a2">Persistence::TypeManager</a> using a global constructor function. A matching deregister call is made in a global destructor, to allow DLL's to use the <a class="el" href="persist_h.html#a1">Persistence::Engine</a> in a main executable.
<p>
<dl compact><dt>
<b>Author(s): </b><dd>
Daniel Silverstone </dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="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 nowrap valign="top"><b>
BaseObject::BaseObject (
</b></td>
<td valign="bottom"><b>
)
</b></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="class_baseobject.html#a4">Read</a>() called on it. </td>
</tr>
</table>
<a name="a1" doxytag="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 nowrap valign="top"><b>
BaseObject::~BaseObject (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></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="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 nowrap valign="top"><b>
const char * BaseObject::GetPersistenceID (
</b></td>
<td valign="bottom"><b>
) const<code> [virtual]</code>
</b></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="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 nowrap valign="top"><b>
<a class="el" href="config_h.html#a17">bool</a> BaseObject::Read (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_engine.html">Engine</a> & <em>archive</em> )<code> [virtual]</code>
</b></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 <a class="el" href="persist_h.html#a1">Persistence::Engine</a> It is not equivalent to the >> operator as it does no typesafety or anything.
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="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 nowrap valign="top"><b>
<a class="el" href="config_h.html#a17">bool</a> BaseObject::Write (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_engine.html">Engine</a> & <em>archive</em> ) const<code> [virtual]</code>
</b></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 <a class="el" href="persist_h.html#a1">Persistence::Engine</a> 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_h-source.html">persist.h</a></ul>
<hr><address><small>Generated at Thu Oct 4 15:32:59 2001 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.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
68d373e54fb21da3730c08bede406633
>
files
>
62
