<!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>GNU CommonC++: ost::MapObject 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="index.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>Classes</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>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_map_object.html">MapObject</a> </div> </div> <div class="contents"> <h1>ost::MapObject Class Reference</h1><!-- doxytag: class="ost::MapObject" --> <p>The <a class="el" href="classost_1_1_map_object.html" title="The MapObject is a base class which can be used to make a derived class operate on...">MapObject</a> is a base class which can be used to make a derived class operate on a <a class="el" href="classost_1_1_map_table.html" title="A map table allows for entities to be mapped (hash index) onto it.">MapTable</a>. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="object_8h_source.html">object.h</a>></code></p> <p><a href="classost_1_1_map_object-members.html">List of all members.</a></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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_object.html#a6919ee804f3beadbe554aca9ec708775">detach</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the object from it's current table. <a href="#a6919ee804f3beadbe554aca9ec708775"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_object.html#ab0e394f746cc1b11f3317f73f40c8386">MapObject</a> (const char *id)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Save id, mark as not using any table. <a href="#ab0e394f746cc1b11f3317f73f40c8386"></a><br/></td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_map_object.html">MapObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_object.html#a165f74010fb15b4019a5ebb6c58628fe">nextObject</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_object.html#aba0b5137c8b7d8e5ed39ad09afac0a7f">idObject</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_map_table.html">MapTable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_object.html#a85a7257f4fe849800e00195bfef3cd93">table</a></td></tr> <tr><td colspan="2"><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_object.html#ae301e900b4cea6b0ed3c2206764c650d">MapTable</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_object.html#a28cd428384a9c342d8e5fdadf7139dc0">MapIndex</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>The <a class="el" href="classost_1_1_map_object.html" title="The MapObject is a base class which can be used to make a derived class operate on...">MapObject</a> is a base class which can be used to make a derived class operate on a <a class="el" href="classost_1_1_map_table.html" title="A map table allows for entities to be mapped (hash index) onto it.">MapTable</a>. </p> <p>Derived classes may override new and delete operators to use managed free list from a <a class="el" href="classost_1_1_map_table.html" title="A map table allows for entities to be mapped (hash index) onto it.">MapTable</a>.</p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> Mappable object. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ab0e394f746cc1b11f3317f73f40c8386"></a><!-- doxytag: member="ost::MapObject::MapObject" ref="ab0e394f746cc1b11f3317f73f40c8386" args="(const char *id)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::MapObject::MapObject </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>id</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Save id, mark as not using any table. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>string for this object. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a6919ee804f3beadbe554aca9ec708775"></a><!-- doxytag: member="ost::MapObject::detach" ref="a6919ee804f3beadbe554aca9ec708775" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::MapObject::detach </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Remove the object from it's current table. </p> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a28cd428384a9c342d8e5fdadf7139dc0"></a><!-- doxytag: member="ost::MapObject::MapIndex" ref="a28cd428384a9c342d8e5fdadf7139dc0" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">friend class <a class="el" href="classost_1_1_map_index.html">MapIndex</a><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ae301e900b4cea6b0ed3c2206764c650d"></a><!-- doxytag: member="ost::MapObject::MapTable" ref="ae301e900b4cea6b0ed3c2206764c650d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">friend class <a class="el" href="classost_1_1_map_table.html">MapTable</a><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="aba0b5137c8b7d8e5ed39ad09afac0a7f"></a><!-- doxytag: member="ost::MapObject::idObject" ref="aba0b5137c8b7d8e5ed39ad09afac0a7f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="classost_1_1_map_object.html#aba0b5137c8b7d8e5ed39ad09afac0a7f">ost::MapObject::idObject</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a165f74010fb15b4019a5ebb6c58628fe"></a><!-- doxytag: member="ost::MapObject::nextObject" ref="a165f74010fb15b4019a5ebb6c58628fe" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_map_object.html">MapObject</a>* <a class="el" href="classost_1_1_map_object.html#a165f74010fb15b4019a5ebb6c58628fe">ost::MapObject::nextObject</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a85a7257f4fe849800e00195bfef3cd93"></a><!-- doxytag: member="ost::MapObject::table" ref="a85a7257f4fe849800e00195bfef3cd93" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_map_table.html">MapTable</a>* <a class="el" href="classost_1_1_map_object.html#a85a7257f4fe849800e00195bfef3cd93">ost::MapObject::table</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="object_8h_source.html">object.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ 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>