nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/trunk/paradiseo-eo/doc/html/classeo_aged.html
legrand c3aec878e5 Paradiseo-eo sources added 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f
2006-12-12 14:49:08 +00:00

233 lines
12 KiB
HTML
Raw Blame History

<!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>EO: eoAged&lt; Object &gt; Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"> <form class="search" action="search.php" method="get">
<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
<h1>eoAged&lt; Object &gt; Class Template Reference</h1>eoAge is a template class that adds an age to an object.\ Requisites for template instantiation are that the object must admit a default ctor and a copy ctor.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="eo_aged_8h-source.html">eoAged.h</a>&gt;</code>
<p>
<a href="classeo_aged-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"><a class="anchor" name="a0" doxytag="eoAged::eoAged"></a>
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_aged.html#a0">eoAged</a> (const Object &amp;_o)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Main ctor from an already built Object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="eoAged::eoAged"></a>
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_aged.html#a1">eoAged</a> (const <a class="el" href="classeo_aged.html">eoAged</a> &amp;_a)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="eoAged::~eoAged"></a>
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_aged.html#a2">~eoAged</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual dtor. They are needed in virtual class hierarchies. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="eoAged::Age"></a>
unsigned long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_aged.html#a3">Age</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the age of the object <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="eoAged::operator++"></a>
const <a class="el" href="classeo_aged.html">eoAged</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_aged.html#a4">operator++</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Increments age. <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Methods from eoObject</div></td></tr>
<tr><td colspan="2"><div class="groupText">readFrom and printOn are directly inherited from eo1d <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_aged.html#z9_0">className</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the class id. <a href="#z9_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_aged.html#z9_1">readFrom</a> (istream &amp;_is)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read object. <a href="#z9_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_aged.html#z9_2">printOn</a> (ostream &amp;_os) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write object. <a href="#z9_2"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_aged.html#d0">eoAged</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default Constructor. <a href="#d0"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r0" doxytag="eoAged::age"></a>
unsigned long&nbsp;</td><td class="memItemRight" valign="bottom"><b>age</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class Object&gt;<br>
class eoAged&lt; Object &gt;</h3>
eoAge is a template class that adds an age to an object.\ Requisites for template instantiation are that the object must admit a default ctor and a copy ctor.
<p>
The Object must be an <a class="el" href="classeo_object.html">eoObject</a>, thus, it must have its methods: className, printOn, readFrom. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classeo_object.html">eoObject</a> </dd></dl>
<p>
<p>
Definition at line <a class="el" href="eo_aged_8h-source.html#l00047">47</a> of file <a class="el" href="eo_aged_8h-source.html">eoAged.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="d0" doxytag="eoAged::eoAged"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class Object&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classeo_aged.html">eoAged</a>&lt; Object &gt;::<a class="el" href="classeo_aged.html">eoAged</a> </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline, private]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Default Constructor.
<p>
\ It<49>s private so that it is not used anywhere; the right way of using this object is to create an Object and passing it to an aged by means of the copy ctor; that way it<69>s turned into an Aged object
<p>
Definition at line <a class="el" href="eo_aged_8h-source.html#l00103">103</a> of file <a class="el" href="eo_aged_8h-source.html">eoAged.h</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z9_0" doxytag="eoAged::className"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class Object&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">virtual std::string <a class="el" href="classeo_aged.html">eoAged</a>&lt; Object &gt;::className </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return the class id.
<p>
This should be redefined in each class; but it's got code as an example of implementation. Only "leaf" classes can be non-virtual.
<p>
Definition at line <a class="el" href="eo_aged_8h-source.html#l00074">74</a> of file <a class="el" href="eo_aged_8h-source.html">eoAged.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z9_1" doxytag="eoAged::readFrom"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class Object&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">virtual void <a class="el" href="classeo_aged.html">eoAged</a>&lt; Object &gt;::readFrom </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">istream &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>_is</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Read object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>_is</em>&nbsp;</td><td>A istream. </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>runtime_exception</em>&nbsp;</td><td>If a valid object can't be read. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="eo_aged_8h-source.html#l00081">81</a> of file <a class="el" href="eo_aged_8h-source.html">eoAged.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z9_2" doxytag="eoAged::printOn"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class Object&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">virtual void <a class="el" href="classeo_aged.html">eoAged</a>&lt; Object &gt;::printOn </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">ostream &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>_os</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Write object.
<p>
It's called printOn since it prints the object _on_ a stream. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>_os</em>&nbsp;</td><td>A ostream. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="eo_aged_8h-source.html#l00091">91</a> of file <a class="el" href="eo_aged_8h-source.html">eoAged.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="eo_aged_8h-source.html">eoAged.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Oct 19 05:06:44 2006 for EO by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink