This file is indexed.

/usr/share/doc/libucommon-dev/a00099.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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
<!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::OrderedIndex 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="a00099.html">OrderedIndex</a>
  </div>
</div>
<div class="contents">
<h1>ucc::OrderedIndex Class Reference</h1><!-- doxytag: class="ucc::OrderedIndex" -->
<p>An index container for maintaining an ordered list of 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::OrderedIndex:</div>
<div class="dynsection">
<div class="center"><img src="a00468.png" border="0" usemap="#ucc_1_1_ordered_index_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_ordered_index_inherit__map" id="ucc_1_1_ordered_index_inherit__map">
<area shape="rect" id="node3" href="a00063.html" title="A template for ordered index of typed name key mapped objects." alt="" coords="5,83,133,112"/><area shape="rect" id="node5" href="a00095.html" title="A queue of double linked object." alt="" coords="157,83,291,112"/><area shape="rect" id="node9" href="a00096.html" title="Template for typesafe basic object fifo container." alt="" coords="315,83,440,112"/><area shape="rect" id="node11" href="a00109.html" title="Manage a thread&#45;safe queue of objects through reference pointers." alt="" coords="464,83,555,112"/><area shape="rect" id="node15" href="a00170.html" title="A timer queue for timer events." alt="" coords="579,83,709,112"/><area shape="rect" id="node7" href="a00097.html" title="Template for typesafe basic object queue container." alt="" coords="151,160,297,189"/><area shape="rect" id="node13" href="a00110.html" title="A templated typed class for thread&#45;safe queue of object pointers." alt="" coords="439,160,580,189"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::OrderedIndex:</div>
<div class="dynsection">
<div class="center"><img src="a00469.png" border="0" usemap="#ucc_1_1_ordered_index_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_ordered_index_coll__map" id="ucc_1_1_ordered_index_coll__map">
<area shape="rect" id="node2" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="5,187,149,216"/><area shape="rect" id="node4" 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="node6" 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="a00099.html#abc4bdc5bb3bbde08453dcb764a3e0fb9">add</a> (<a class="el" href="a00100.html">OrderedObject</a> *ordered)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add an object into the ordered index.  <a href="#abc4bdc5bb3bbde08453dcb764a3e0fb9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00069.html">LinkedObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#a1f80e970f1803ac2502f645a2b973e3d">begin</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return first object in list for iterators.  <a href="#a1f80e970f1803ac2502f645a2b973e3d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#aed2fbd680367ca566e539035e606bc44">count</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Count of objects this list manages.  <a href="#aed2fbd680367ca566e539035e606bc44"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00069.html">LinkedObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#a93229b195c0fe1acd4d131c9e0f085f1">end</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return last object in list for iterators.  <a href="#a93229b195c0fe1acd4d131c9e0f085f1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00069.html">LinkedObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#a242e2edb979ec09f6a053ba067ccd058">find</a> (unsigned offset) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find a specific member in the ordered list.  <a href="#a242e2edb979ec09f6a053ba067ccd058"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00069.html">LinkedObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#a50f3131b350d18e1d407708455e0137d">get</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get (pull) object off the list.  <a href="#a50f3131b350d18e1d407708455e0137d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00069.html">LinkedObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#a94cee0aa6530635604b5af542ddbe551">getIndexed</a> (unsigned index) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get an indexed member from the ordered index.  <a href="#a94cee0aa6530635604b5af542ddbe551"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00069.html">LinkedObject</a> **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#a3cb31c189dd78a082ac49ac29b0b3e9f">index</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a pointer to the head of the list.  <a href="#a3cb31c189dd78a082ac49ac29b0b3e9f"></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="a00099.html#aaf937905aef21f376e3b05d9a159c580">lock_index</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to synchronize lists managed by multiple threads.  <a href="#aaf937905aef21f376e3b05d9a159c580"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00069.html">LinkedObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#a535b4bc575cf470d38187383f59963a0">operator*</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return head object pointer.  <a href="#a535b4bc575cf470d38187383f59963a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#a3ebfdcef8eaeeea9f5919760c6d832a4">operator*=</a> (<a class="el" href="a00100.html">OrderedObject</a> *object)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add object to our list.  <a href="#a3ebfdcef8eaeeea9f5919760c6d832a4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60c141251b9f5003c05886fb1b4227dc"></a><!-- doxytag: member="ucc::OrderedIndex::OrderedIndex" ref="a60c141251b9f5003c05886fb1b4227dc" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#a60c141251b9f5003c05886fb1b4227dc">OrderedIndex</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create and initialize an empty index. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07b4424a816610c7e182dae4dc66b82d"></a><!-- doxytag: member="ucc::OrderedIndex::purge" ref="a07b4424a816610c7e182dae4dc66b82d" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#a07b4424a816610c7e182dae4dc66b82d">purge</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Purge the linked list and then set the index to empty. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#a4599cf4657b0911f1c86112bb39fdbac">unlock_index</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to synchronize lists managed by multiple threads.  <a href="#a4599cf4657b0911f1c86112bb39fdbac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3dcfc22520be17bf541ca30413581b55"></a><!-- doxytag: member="ucc::OrderedIndex::~OrderedIndex" ref="a3dcfc22520be17bf541ca30413581b55" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00099.html#a3dcfc22520be17bf541ca30413581b55">~OrderedIndex</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy index. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2c003df74f8e2ce2270bc3082c6c98f"></a><!-- doxytag: member="ucc::OrderedIndex::head" ref="ab2c003df74f8e2ce2270bc3082c6c98f" args="" -->
<a class="el" href="a00100.html">OrderedObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>head</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a158f8905e603b0c892d34113aecc6f57"></a><!-- doxytag: member="ucc::OrderedIndex::tail" ref="a158f8905e603b0c892d34113aecc6f57" args="" -->
<a class="el" href="a00100.html">OrderedObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>tail</b></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::OrderedIndex::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::OrderedIndex::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="aff917ff3b53052c4f3f2481fb7d6908f"></a><!-- doxytag: member="ucc::OrderedIndex::NamedObject" ref="aff917ff3b53052c4f3f2481fb7d6908f" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>NamedObject</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0369fa20b5664238bd703d61ec455bd9"></a><!-- doxytag: member="ucc::OrderedIndex::OrderedObject" ref="a0369fa20b5664238bd703d61ec455bd9" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>OrderedObject</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An index container for maintaining an ordered list of objects. </p>
<p>This index holds a pointer to the head and tail of an ordered list of linked objects. Fundimental methods for supporting iterators are also provided. </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#l00175">175</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abc4bdc5bb3bbde08453dcb764a3e0fb9"></a><!-- doxytag: member="ucc::OrderedIndex::add" ref="abc4bdc5bb3bbde08453dcb764a3e0fb9" args="(OrderedObject *ordered)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::OrderedIndex::add </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00100.html">OrderedObject</a> *&nbsp;</td>
          <td class="paramname"> <em>ordered</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Add an object into the ordered 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>ordered</em>&nbsp;</td><td>object to add to the index. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a1f80e970f1803ac2502f645a2b973e3d"></a><!-- doxytag: member="ucc::OrderedIndex::begin" ref="a1f80e970f1803ac2502f645a2b973e3d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00069.html">LinkedObject</a>* ucc::OrderedIndex::begin </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>Return first object in list for iterators. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>first object in list. </dd></dl>

<p>Definition at line <a class="el" href="a00195_source.html#l00258">258</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>

</div>
</div>
<a class="anchor" id="aed2fbd680367ca566e539035e606bc44"></a><!-- doxytag: member="ucc::OrderedIndex::count" ref="aed2fbd680367ca566e539035e606bc44" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned ucc::OrderedIndex::count </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Count of objects this list manages. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of objects in the list. </dd></dl>

</div>
</div>
<a class="anchor" id="a93229b195c0fe1acd4d131c9e0f085f1"></a><!-- doxytag: member="ucc::OrderedIndex::end" ref="a93229b195c0fe1acd4d131c9e0f085f1" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00069.html">LinkedObject</a>* ucc::OrderedIndex::end </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>Return last object in list for iterators. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>last object in list. </dd></dl>

<p>Definition at line <a class="el" href="a00195_source.html#l00265">265</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>

</div>
</div>
<a class="anchor" id="a242e2edb979ec09f6a053ba067ccd058"></a><!-- doxytag: member="ucc::OrderedIndex::find" ref="a242e2edb979ec09f6a053ba067ccd058" args="(unsigned offset) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00069.html">LinkedObject</a>* ucc::OrderedIndex::find </td>
          <td>(</td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>offset</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Find a specific member in the ordered list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>to member to find. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a50f3131b350d18e1d407708455e0137d"></a><!-- doxytag: member="ucc::OrderedIndex::get" ref="a50f3131b350d18e1d407708455e0137d" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00069.html">LinkedObject</a>* ucc::OrderedIndex::get </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get (pull) object off the list. </p>
<p>The start of the list is advanced to the next object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="a00069.html" title="Common base class for all objects that can be formed into a linked list.">LinkedObject</a> based object that was head of the list. </dd></dl>

</div>
</div>
<a class="anchor" id="a94cee0aa6530635604b5af542ddbe551"></a><!-- doxytag: member="ucc::OrderedIndex::getIndexed" ref="a94cee0aa6530635604b5af542ddbe551" args="(unsigned index) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00069.html">LinkedObject</a>* ucc::OrderedIndex::getIndexed </td>
          <td>(</td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>index</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get an indexed member from the ordered 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>of member to fetch. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="a00069.html" title="Common base class for all objects that can be formed into a linked list.">LinkedObject</a> member of index. </dd></dl>

<p>Definition at line <a class="el" href="a00195_source.html#l00251">251</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3cb31c189dd78a082ac49ac29b0b3e9f"></a><!-- doxytag: member="ucc::OrderedIndex::index" ref="a3cb31c189dd78a082ac49ac29b0b3e9f" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00069.html">LinkedObject</a>** ucc::OrderedIndex::index </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return a pointer to the head of the list. </p>
<p>This allows the head pointer to be used like a simple root list pointer for pure <a class="el" href="a00069.html" title="Common base class for all objects that can be formed into a linked list.">LinkedObject</a> based objects. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>LinkedIndex style object. </dd></dl>

</div>
</div>
<a class="anchor" id="aaf937905aef21f376e3b05d9a159c580"></a><!-- doxytag: member="ucc::OrderedIndex::lock_index" ref="aaf937905aef21f376e3b05d9a159c580" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ucc::OrderedIndex::lock_index </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Used to synchronize lists managed by multiple threads. </p>
<p>A derived locking method would be invoked. </p>

</div>
</div>
<a class="anchor" id="a535b4bc575cf470d38187383f59963a0"></a><!-- doxytag: member="ucc::OrderedIndex::operator*" ref="a535b4bc575cf470d38187383f59963a0" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00069.html">LinkedObject</a>* ucc::OrderedIndex::operator* </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return head object pointer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>head pointer. </dd></dl>

<p>Definition at line <a class="el" href="a00195_source.html#l00272">272</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3ebfdcef8eaeeea9f5919760c6d832a4"></a><!-- doxytag: member="ucc::OrderedIndex::operator*=" ref="a3ebfdcef8eaeeea9f5919760c6d832a4" args="(OrderedObject *object)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::OrderedIndex::operator*= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00100.html">OrderedObject</a> *&nbsp;</td>
          <td class="paramname"> <em>object</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Add object to our list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>object</em>&nbsp;</td><td>to add. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a4599cf4657b0911f1c86112bb39fdbac"></a><!-- doxytag: member="ucc::OrderedIndex::unlock_index" ref="a4599cf4657b0911f1c86112bb39fdbac" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ucc::OrderedIndex::unlock_index </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Used to synchronize lists managed by multiple threads. </p>
<p>A derived unlocking method would be invoked. </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>