/usr/share/doc/libucommon-dev/a00107.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 | <!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"/>
<title>UCommon: ucc::PersistObject Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.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>Data Structures</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 class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00107.html">PersistObject</a>
</div>
</div>
<div class="contents">
<h1>ucc::PersistObject Class Reference</h1><!-- doxytag: class="ucc::PersistObject" -->
<p><a class="el" href="a00107.html" title="PersistObject.">PersistObject</a>.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00200_source.html">persist.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0031cca44ac3631225a62cf36c235ee6"></a><!-- doxytag: member="ucc::PersistObject::getPersistenceID" ref="a0031cca44ac3631225a62cf36c235ee6" args="() const " -->
virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00107.html#a0031cca44ac3631225a62cf36c235ee6">getPersistenceID</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This returns the ID of the persistent object (Its type). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00107.html#a8c2c276ab427a1ae9d819dd40fccfb94">PersistObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This constructor is used in serialisation processes. <a href="#a8c2c276ab427a1ae9d819dd40fccfb94"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37cb17a93993ca046ad45616cef71acb"></a><!-- doxytag: member="ucc::PersistObject::read" ref="a37cb17a93993ca046ad45616cef71acb" args="(PersistEngine &archive)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00107.html#a37cb17a93993ca046ad45616cef71acb">read</a> (<a class="el" href="a00106.html">PersistEngine</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. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a082d2616009a8a5ed736ffc69cfa6118"></a><!-- doxytag: member="ucc::PersistObject::write" ref="a082d2616009a8a5ed736ffc69cfa6118" args="(PersistEngine &archive) const " -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00107.html#a082d2616009a8a5ed736ffc69cfa6118">write</a> (<a class="el" href="a00106.html">PersistEngine</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. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefa4b51b758f7ce57b8a5de499695c95"></a><!-- doxytag: member="ucc::PersistObject::~PersistObject" ref="aefa4b51b758f7ce57b8a5de499695c95" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00107.html#aefa4b51b758f7ce57b8a5de499695c95">~PersistObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="a00107.html" title="PersistObject.">PersistObject</a>. </p>
<p>Base class for classes that will be persistent. 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="author"><dt><b>Author:</b></dt><dd>Daniel Silverstone </dd></dl>
<p>Definition at line <a class="el" href="a00200_source.html#l00147">147</a> of file <a class="el" href="a00200_source.html">persist.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8c2c276ab427a1ae9d819dd40fccfb94"></a><!-- doxytag: member="ucc::PersistObject::PersistObject" ref="a8c2c276ab427a1ae9d819dd40fccfb94" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::PersistObject::PersistObject </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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00200_source.html">persist.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:39 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|