libucommon-doc 3.2.0-0ubuntu1 / usr / share / doc / libucommon-dev / a00100.html

This file is indexed.

/usr/share/doc/libucommon-dev/a00100.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
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
<!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::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&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;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&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00100.html">OrderedObject</a>
  </div>
</div>
<div class="contents">
<h1>ucc::OrderedObject Class Reference</h1><!-- doxytag: class="ucc::OrderedObject" --><!-- doxytag: inherits="ucc::LinkedObject" -->
<p>A linked object base class for ordered objects.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00195_source.html">linked.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucc::OrderedObject:</div>
<div class="dynsection">
<div class="center"><img src="a00470.png" border="0" usemap="#ucc_1_1_ordered_object_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_ordered_object_inherit__map" id="ucc_1_1_ordered_object_inherit__map">
<area shape="rect" id="node7" href="a00051.html" title="A double&#45;linked Object, used for certain kinds of lists." alt="" coords="537,5,681,35"/><area shape="rect" id="node9" href="a00060.html" title="Data keys parsed from a keyfile." alt="" coords="559,59,660,88"/><area shape="rect" id="node11" href="a00061.html" title="A key value set is used for iterative access." alt="" coords="527,112,692,141"/><area shape="rect" id="node13" href="a00068.html" title="A double linked list object." alt="" coords="552,165,667,195"/><area shape="rect" id="node17" href="a00090.html" title="A linked object base class with members found by name." alt="" coords="540,219,679,248"/><area shape="rect" id="node23" href="a00121.html" title="A class to collect compile&#45;time errors." alt="" coords="547,272,672,301"/><area shape="rect" id="node25" href="a00148.html" title="A base class used to create parsable shell options." alt="" coords="544,325,675,355"/><area shape="rect" id="node2" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="148,165,281,195"/><area shape="rect" id="node4" href="a00093.html" title="A common base class for all managed objects." alt="" coords="5,165,99,195"/><area shape="rect" id="node15" href="a00171.html" title="A timer event object that lives on a timer queue." alt="" coords="743,165,916,195"/><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="767,219,892,248"/><area shape="rect" id="node21" href="a00174.html" title="Embed data objects into a tree structured memory database." alt="" coords="965,219,1109,248"/><area shape="rect" id="node27" href="a00143.html" title="Character option for shell parsing." alt="" coords="760,272,899,301"/><area shape="rect" id="node29" href="a00145.html" title="Flag option for shell parsing." alt="" coords="763,325,896,355"/><area shape="rect" id="node31" href="a00147.html" title="Numeric option for shell parsing." alt="" coords="748,379,911,408"/><area shape="rect" id="node33" href="a00150.html" title="Text option for shell parsing." alt="" coords="756,432,903,461"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::OrderedObject:</div>
<div class="dynsection">
<div class="center"><img src="a00471.png" border="0" usemap="#ucc_1_1_ordered_object_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_ordered_object_coll__map" id="ucc_1_1_ordered_object_coll__map">
<area shape="rect" id="node2" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="11,96,144,125"/><area shape="rect" id="node4" href="a00093.html" title="A common base class for all managed objects." alt="" coords="31,5,124,35"/></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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#a8e83ede0a43af5c5f650a58949383ded">delist</a> (<a class="el" href="a00099.html">OrderedIndex</a> *index)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove our ordered object from an existing index.  <a href="#a8e83ede0a43af5c5f650a58949383ded"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#a90929a08fd0825096a4ca3ed3512d958">enlist</a> (<a class="el" href="a00099.html">OrderedIndex</a> *index)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">List our ordered object in default strategy mode.  <a href="#a90929a08fd0825096a4ca3ed3512d958"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#a448ac5c0801cc0218308b805ff685834">enlistHead</a> (<a class="el" href="a00099.html">OrderedIndex</a> *index)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">List our ordered object at start of a linked list on an index.  <a href="#a448ac5c0801cc0218308b805ff685834"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#a1b2bb11963c706aa04582833aa05b2d2">enlistTail</a> (<a class="el" href="a00099.html">OrderedIndex</a> *index)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">List our ordered object at end of a linked list on an index.  <a href="#a1b2bb11963c706aa04582833aa05b2d2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00100.html">OrderedObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#a474f11168e0fb3c9674df8ca949958c5">getNext</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get next ordered member when iterating.  <a href="#a474f11168e0fb3c9674df8ca949958c5"></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="ae01f6bde6c30e10ba59f0985d110fb0b"></a><!-- doxytag: member="ucc::OrderedObject::OrderedObject" ref="ae01f6bde6c30e10ba59f0985d110fb0b" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#ae01f6bde6c30e10ba59f0985d110fb0b">OrderedObject</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct an ordered object unattached. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#afcdf9a07139a0c2ef0af918e25339eea">OrderedObject</a> (<a class="el" href="a00099.html">OrderedIndex</a> *index)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct an ordered object aot end of a an index.  <a href="#afcdf9a07139a0c2ef0af918e25339eea"></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="ucc::OrderedObject::DLinkedObject" ref="a98e0d80baed2f0af623c216518687dba" args="" -->
class&nbsp;</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="ucc::OrderedObject::LinkedList" ref="af71fad9f4990e232af55c73aeddb3823" args="" -->
class&nbsp;</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="ucc::OrderedObject::ObjectQueue" ref="ac8d4715315b25a70087c9bec56a10be1" args="" -->
class&nbsp;</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="ucc::OrderedObject::OrderedIndex" ref="a9f59a4fff2442671ca3c40e482e8f41f" args="" -->
class&nbsp;</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="a00099.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 &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00195_source.html#l00288">288</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="afcdf9a07139a0c2ef0af918e25339eea"></a><!-- doxytag: member="ucc::OrderedObject::OrderedObject" ref="afcdf9a07139a0c2ef0af918e25339eea" args="(OrderedIndex *index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::OrderedObject::OrderedObject </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00099.html">OrderedIndex</a> *&nbsp;</td>
          <td class="paramname"> <em>index</em></td>
          <td>&nbsp;)&nbsp;</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>&nbsp;</td><td>we are listed on. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8e83ede0a43af5c5f650a58949383ded"></a><!-- doxytag: member="ucc::OrderedObject::delist" ref="a8e83ede0a43af5c5f650a58949383ded" args="(OrderedIndex *index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::OrderedObject::delist </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00099.html">OrderedIndex</a> *&nbsp;</td>
          <td class="paramname"> <em>index</em></td>
          <td>&nbsp;)&nbsp;</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>&nbsp;</td><td>we are listed on. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a90929a08fd0825096a4ca3ed3512d958"></a><!-- doxytag: member="ucc::OrderedObject::enlist" ref="a90929a08fd0825096a4ca3ed3512d958" args="(OrderedIndex *index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ucc::OrderedObject::enlist </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00099.html">OrderedIndex</a> *&nbsp;</td>
          <td class="paramname"> <em>index</em></td>
          <td>&nbsp;)&nbsp;</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>&nbsp;</td><td>we are listing on. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented in <a class="el" href="a00068.html#ad0a1c3a890d6eb5ee400a5721b01cb66">ucc::LinkedList</a>.</p>

</div>
</div>
<a class="anchor" id="a448ac5c0801cc0218308b805ff685834"></a><!-- doxytag: member="ucc::OrderedObject::enlistHead" ref="a448ac5c0801cc0218308b805ff685834" args="(OrderedIndex *index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::OrderedObject::enlistHead </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00099.html">OrderedIndex</a> *&nbsp;</td>
          <td class="paramname"> <em>index</em></td>
          <td>&nbsp;)&nbsp;</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>&nbsp;</td><td>we are listing on. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented in <a class="el" href="a00068.html#a07a666bfcb1419018e01b5eddcf67f9a">ucc::LinkedList</a>.</p>

</div>
</div>
<a class="anchor" id="a1b2bb11963c706aa04582833aa05b2d2"></a><!-- doxytag: member="ucc::OrderedObject::enlistTail" ref="a1b2bb11963c706aa04582833aa05b2d2" args="(OrderedIndex *index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::OrderedObject::enlistTail </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00099.html">OrderedIndex</a> *&nbsp;</td>
          <td class="paramname"> <em>index</em></td>
          <td>&nbsp;)&nbsp;</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>&nbsp;</td><td>we are listing on. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented in <a class="el" href="a00068.html#a1a464c4d1a4cf8366f87e5ba620bd1df">ucc::LinkedList</a>.</p>

</div>
</div>
<a class="anchor" id="a474f11168e0fb3c9674df8ca949958c5"></a><!-- doxytag: member="ucc::OrderedObject::getNext" ref="a474f11168e0fb3c9674df8ca949958c5" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00100.html">OrderedObject</a>* ucc::OrderedObject::getNext </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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="a00069.html#acc25bd6615a2163028724910135b2cd2">ucc::LinkedObject</a>.</p>

<p>Reimplemented in <a class="el" href="a00090.html#ac94a45bc0e7e47974b633631618ba7c8">ucc::NamedObject</a>, and <a class="el" href="a00068.html#a357f9ca691c64644d42d9630fd9ca288">ucc::LinkedList</a>.</p>

<p>Definition at line <a class="el" href="a00195_source.html#l00337">337</a> of file <a class="el" href="a00195_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="a00195_source.html">linked.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:38 2010 for UCommon by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.