Sophie

Sophie

distrib > Mandriva > 8.2 > i586 > media > contrib > by-pkgid > 68d373e54fb21da3730c08bede406633 > files > 59

libCommonC++1.9_3-devel-1.9.4-2mdk.i586.rpm

<!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>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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>BaseObject  Class Reference</h1>BaseObject Base class for classes that will be persistent. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="persist_8h-source.html">persist.h</a>&gt;</code>
<p>
<a href="class_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>&nbsp;</td><td valign=bottom><a class="el" href="class_base_object.html#a0">CCXX_MEMBER_EXPORT</a> (CCXX_EMPTY) BaseObject()</td></tr>
<tr><td>&nbsp;</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>&nbsp;</td><td valign=bottom><a class="el" href="class_base_object.html#a1">CCXX_MEMBER_EXPORT</a> (virtual)~BaseObject()</td></tr>
<tr><td>&nbsp;</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>&nbsp;</td><td valign=bottom><a class="el" href="class_base_object.html#a2">CCXX_MEMBER_EXPORT</a> (virtual const char *) GetPersistenceID() const</td></tr>
<tr><td>&nbsp;</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>&nbsp;</td><td valign=bottom><a class="el" href="class_base_object.html#a3">CCXX_MEMBER_EXPORT</a> (virtual bool) Write(<a class="el" href="class_engine.html">Engine</a> &amp;archive) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This method is used to write to the Persistence::Engine It is not equivalent to the &lt;&lt; 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>&nbsp;</td><td valign=bottom><a class="el" href="class_base_object.html#a4">CCXX_MEMBER_EXPORT</a> (virtual bool) Read(<a class="el" href="class_engine.html">Engine</a> &amp;archive)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This method is used to read from a Persistence::Engine It is not equivalent to the &gt;&gt; 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>
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 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>Member Function Documentation</h2>
<a name="a4" doxytag="BaseObject::CCXX_MEMBER_EXPORT"></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"> BaseObject::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">virtual</td>
          <td class="mdname1">&nbsp; <em>bool</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This method is used to read from a Persistence::Engine It is not equivalent to the &gt;&gt; operator as it does no typesafety or anything.
<p>
    </td>
  </tr>
</table>
<a name="a3" doxytag="BaseObject::CCXX_MEMBER_EXPORT"></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"> BaseObject::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">virtual</td>
          <td class="mdname1">&nbsp; <em>bool</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This method is used to write to the Persistence::Engine It is not equivalent to the &lt;&lt; operator as it writes only the data and not the object type etc.
<p>
    </td>
  </tr>
</table>
<a name="a2" doxytag="BaseObject::CCXX_MEMBER_EXPORT"></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"> BaseObject::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">virtual const char *</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This returns the ID of the persistent object (Its type).
<p>
    </td>
  </tr>
</table>
<a name="a1" doxytag="BaseObject::CCXX_MEMBER_EXPORT"></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"> BaseObject::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">virtual</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Default destructor.
<p>
    </td>
  </tr>
</table>
<a name="a0" doxytag="BaseObject::CCXX_MEMBER_EXPORT"></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"> BaseObject::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">CCXX_EMPTY</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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>
<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 Tue Nov 20 13:28:47 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.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 &copy;&nbsp;1997-2001</small></address>
</body>
</html>