<!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: ucommon::OrderedObject 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="a00208.html">ucommon</a>::<a class="el" href="a00101.html">OrderedObject</a>
</div>
</div>
<div class="contents">
<h1>ucommon::OrderedObject Class Reference</h1><!-- doxytag: class="ucommon::OrderedObject" --><!-- doxytag: inherits="ucommon::LinkedObject" -->
<p>A linked object base class for ordered objects.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00188_source.html">linked.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::OrderedObject:</div>
<div class="dynsection">
<div class="center"><img src="a00465.png" border="0" usemap="#ucommon_1_1_ordered_object_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1_ordered_object_inherit__map" id="ucommon_1_1_ordered_object_inherit__map">
<area shape="rect" id="node7" href="a00047.html" title="A double-linked Object, used for certain kinds of lists." alt="" coords="897,5,1140,32"/><area shape="rect" id="node9" href="a00055.html" title="Data keys parsed from a keyfile." alt="" coords="928,56,1109,83"/><area shape="rect" id="node11" href="a00056.html" title="A key value set is used for iterative access." alt="" coords="877,107,1160,133"/><area shape="rect" id="node13" href="a00066.html" title="A double linked list object." alt="" coords="913,157,1124,184"/><area shape="rect" id="node17" href="a00090.html" title="A linked object base class with members found by name." alt="" coords="908,208,1129,235"/><area shape="rect" id="node23" href="a00137.html" title="A base class used to create parsable shell options." alt="" coords="897,360,1140,387"/><area shape="rect" id="node2" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="307,132,539,159"/><area shape="rect" id="node4" href="a00095.html" title="A common base class for all managed objects." alt="" coords="7,132,257,159"/><area shape="rect" id="node15" href="a00164.html" title="A timer event object that lives on a timer queue." alt="" coords="1208,157,1491,184"/><area shape="rect" id="node19" href="a00091.html" title="The named tree class is used to form a tree oriented list of associated objects." alt="" coords="1248,208,1451,235"/><area shape="rect" id="node21" href="a00166.html" title="Embed data objects into a tree structured memory database." alt="" coords="1539,208,1771,235"/><area shape="rect" id="node25" href="a00130.html" title="Character option for shell parsing." alt="" coords="1224,259,1475,285"/><area shape="rect" id="node27" href="a00131.html" title="Counter option for shell parsing." alt="" coords="1208,309,1491,336"/><area shape="rect" id="node29" href="a00133.html" title="Flag option for shell parsing." alt="" coords="1224,360,1475,387"/><area shape="rect" id="node31" href="a00134.html" title="Grouping option." alt="" coords="1219,411,1480,437"/><area shape="rect" id="node33" href="a00136.html" title="Numeric option for shell parsing." alt="" coords="1208,461,1491,488"/><area shape="rect" id="node35" href="a00139.html" title="Text option for shell parsing." alt="" coords="1213,512,1485,539"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::OrderedObject:</div>
<div class="dynsection">
<div class="center"><img src="a00466.png" border="0" usemap="#ucommon_1_1_ordered_object_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1_ordered_object_coll__map" id="ucommon_1_1_ordered_object_coll__map">
<area shape="rect" id="node2" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="15,91,247,117"/><area shape="rect" id="node4" href="a00095.html" title="A common base class for all managed objects." alt="" coords="5,5,256,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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="a00101.html#ab3cc7ff9b962138e8736b520872b3bb7">delist</a> (<a class="el" href="a00100.html">OrderedIndex</a> *index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove our ordered object from an existing index. <a href="#ab3cc7ff9b962138e8736b520872b3bb7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00101.html#a880037f6f10cf0e9ab0af31de8804890">enlist</a> (<a class="el" href="a00100.html">OrderedIndex</a> *index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">List our ordered object in default strategy mode. <a href="#a880037f6f10cf0e9ab0af31de8804890"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00101.html#a8accf09eb5f763616ce0d2ee82d10661">enlistHead</a> (<a class="el" href="a00100.html">OrderedIndex</a> *index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">List our ordered object at start of a linked list on an index. <a href="#a8accf09eb5f763616ce0d2ee82d10661"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00101.html#a7d3b09f93a67b3de6ff457ab6faf1133">enlistTail</a> (<a class="el" href="a00100.html">OrderedIndex</a> *index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">List our ordered object at end of a linked list on an index. <a href="#a7d3b09f93a67b3de6ff457ab6faf1133"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00101.html">OrderedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00101.html#af272ffa8eee0c8f4297df4cc4d2f0c27">getNext</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get next ordered member when iterating. <a href="#af272ffa8eee0c8f4297df4cc4d2f0c27"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a670a6c36026adb054836b4b8fd38b24a"></a><!-- doxytag: member="ucommon::OrderedObject::OrderedObject" ref="a670a6c36026adb054836b4b8fd38b24a" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00101.html#a670a6c36026adb054836b4b8fd38b24a">OrderedObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an ordered object unattached. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00101.html#a16012beb9905dfc78ee2827f1ffeeb90">OrderedObject</a> (<a class="el" href="a00100.html">OrderedIndex</a> *index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an ordered object aot end of a an index. <a href="#a16012beb9905dfc78ee2827f1ffeeb90"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98e0d80baed2f0af623c216518687dba"></a><!-- doxytag: member="ucommon::OrderedObject::DLinkedObject" ref="a98e0d80baed2f0af623c216518687dba" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>DLinkedObject</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af71fad9f4990e232af55c73aeddb3823"></a><!-- doxytag: member="ucommon::OrderedObject::LinkedList" ref="af71fad9f4990e232af55c73aeddb3823" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>LinkedList</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8d4715315b25a70087c9bec56a10be1"></a><!-- doxytag: member="ucommon::OrderedObject::ObjectQueue" ref="ac8d4715315b25a70087c9bec56a10be1" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>ObjectQueue</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f59a4fff2442671ca3c40e482e8f41f"></a><!-- doxytag: member="ucommon::OrderedObject::OrderedIndex" ref="a9f59a4fff2442671ca3c40e482e8f41f" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>OrderedIndex</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A linked object base class for ordered objects. </p>
<p>This is used for objects that must be ordered and listed through the <a class="el" href="a00100.html" title="An index container for maintaining an ordered list of objects.">OrderedIndex</a> class. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00293">293</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a16012beb9905dfc78ee2827f1ffeeb90"></a><!-- doxytag: member="ucommon::OrderedObject::OrderedObject" ref="a16012beb9905dfc78ee2827f1ffeeb90" args="(OrderedIndex *index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::OrderedObject::OrderedObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00100.html">OrderedIndex</a> * </td>
<td class="paramname"> <em>index</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an ordered object aot end of a an index. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>we are listed on. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab3cc7ff9b962138e8736b520872b3bb7"></a><!-- doxytag: member="ucommon::OrderedObject::delist" ref="ab3cc7ff9b962138e8736b520872b3bb7" args="(OrderedIndex *index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::OrderedObject::delist </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00100.html">OrderedIndex</a> * </td>
<td class="paramname"> <em>index</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove our ordered object from an existing index. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>we are listed on. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a880037f6f10cf0e9ab0af31de8804890"></a><!-- doxytag: member="ucommon::OrderedObject::enlist" ref="a880037f6f10cf0e9ab0af31de8804890" args="(OrderedIndex *index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ucommon::OrderedObject::enlist </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00100.html">OrderedIndex</a> * </td>
<td class="paramname"> <em>index</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>List our ordered object in default strategy mode. </p>
<p>The default base class uses enlistTail. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>we are listing on. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="a00066.html#a540134032159cc22f4ce5dfc7c2eff3c">ucommon::LinkedList</a>.</p>
</div>
</div>
<a class="anchor" id="a8accf09eb5f763616ce0d2ee82d10661"></a><!-- doxytag: member="ucommon::OrderedObject::enlistHead" ref="a8accf09eb5f763616ce0d2ee82d10661" args="(OrderedIndex *index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::OrderedObject::enlistHead </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00100.html">OrderedIndex</a> * </td>
<td class="paramname"> <em>index</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>List our ordered object at start of a linked list on an index. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>we are listing on. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="a00066.html#aabbb806520e59debc5a65bcab26030fc">ucommon::LinkedList</a>.</p>
</div>
</div>
<a class="anchor" id="a7d3b09f93a67b3de6ff457ab6faf1133"></a><!-- doxytag: member="ucommon::OrderedObject::enlistTail" ref="a7d3b09f93a67b3de6ff457ab6faf1133" args="(OrderedIndex *index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::OrderedObject::enlistTail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00100.html">OrderedIndex</a> * </td>
<td class="paramname"> <em>index</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>List our ordered object at end of a linked list on an index. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>we are listing on. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="a00066.html#ab8c5117ecce3f9bc886ca9ad3b22cb86">ucommon::LinkedList</a>.</p>
</div>
</div>
<a class="anchor" id="af272ffa8eee0c8f4297df4cc4d2f0c27"></a><!-- doxytag: member="ucommon::OrderedObject::getNext" ref="af272ffa8eee0c8f4297df4cc4d2f0c27" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00101.html">OrderedObject</a>* ucommon::OrderedObject::getNext </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get next ordered member when iterating. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next ordered object. </dd></dl>
<p>Reimplemented from <a class="el" href="a00067.html#a04d24fc1e0319ec60206831ff467f73a">ucommon::LinkedObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00090.html#a64f5e6ff6811af6cbf8d0f94628e44c9">ucommon::NamedObject</a>, and <a class="el" href="a00066.html#a929bc52294f4f1133363db0031972d3f">ucommon::LinkedList</a>.</p>
<p>Definition at line <a class="el" href="a00188_source.html#l00342">342</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00188_source.html">linked.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:50 2011 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>
