<!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: OrderedIndex Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ucommon</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>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 id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00098.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>OrderedIndex Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="OrderedIndex" -->
<p>An index container for maintaining an ordered list of objects.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00187_source.html">linked.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for OrderedIndex:</div>
<div class="dyncontent">
<div class="center"><img src="a00397.png" border="0" usemap="#_ordered_index_inherit__map" alt="Inheritance graph"/></div>
<map name="_ordered_index_inherit__map" id="_ordered_index_inherit__map">
<area shape="rect" id="node3" href="a00057.html" title="A template for ordered index of typed name key mapped objects." alt="" coords="5,80,147,107"/><area shape="rect" id="node5" href="a00094.html" title="A queue of double linked object." alt="" coords="171,80,301,107"/><area shape="rect" id="node9" href="a00095.html" title="Template for typesafe basic object fifo container." alt="" coords="325,80,467,107"/><area shape="rect" id="node11" href="a00109.html" title="Manage a thread-safe queue of objects through reference pointers." alt="" coords="491,80,563,107"/><area shape="rect" id="node15" href="a00162.html" title="A timer queue for timer events." alt="" coords="587,80,709,107"/><area shape="rect" id="node7" href="a00096.html" title="Template for typesafe basic object queue container." alt="" coords="160,155,312,181"/><area shape="rect" id="node13" href="a00110.html" title="A templated typed class for thread-safe queue of object pointers." alt="" coords="456,155,597,181"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for OrderedIndex:</div>
<div class="dyncontent">
<div class="center"><img src="a00398.png" border="0" usemap="#_ordered_index_coll__map" alt="Collaboration graph"/></div>
<map name="_ordered_index_coll__map" id="_ordered_index_coll__map">
<area shape="rect" id="node2" href="a00099.html" title="A linked object base class for ordered objects." alt="" coords="5,176,157,203"/><area shape="rect" id="node4" href="a00065.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="11,91,152,117"/><area shape="rect" id="node6" href="a00091.html" title="A common base class for all managed objects." alt="" coords="40,5,123,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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="a00098.html#a8fa77a4e85265a040f877625f08242aa">add</a> (<a class="el" href="a00099.html">OrderedObject</a> *ordered)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an object into the ordered index. <a href="#a8fa77a4e85265a040f877625f08242aa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00065.html">LinkedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a3a2267828b2a27933050009fa6dc5f35">begin</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return first object in list for iterators. <a href="#a3a2267828b2a27933050009fa6dc5f35"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a2d2f03c6b41c1d76dbf12768c872c632">count</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Count of objects this list manages. <a href="#a2d2f03c6b41c1d76dbf12768c872c632"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00065.html">LinkedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a7eb0273007518790a22626de8fea9e59">end</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return last object in list for iterators. <a href="#a7eb0273007518790a22626de8fea9e59"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00065.html">LinkedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a7cc5a22fd33044a20b0b63c166b77974">find</a> (unsigned offset) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a specific member in the ordered list. <a href="#a7cc5a22fd33044a20b0b63c166b77974"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00065.html">LinkedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#aa4e54d266fac3664cafc0d03804ad84d">get</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get (pull) object off the list. <a href="#aa4e54d266fac3664cafc0d03804ad84d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00065.html">LinkedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#ac7c483d8d3044906d92e379dd6d3a591">getIndexed</a> (unsigned index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an indexed member from the ordered index. <a href="#ac7c483d8d3044906d92e379dd6d3a591"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00065.html">LinkedObject</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a84e274a96c88a579a4e27f32c781480f">index</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the head of the list. <a href="#a84e274a96c88a579a4e27f32c781480f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#acfff06a41ca74c1ccecabb6ed32a44a5">lock_index</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to synchronize lists managed by multiple threads. <a href="#acfff06a41ca74c1ccecabb6ed32a44a5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00065.html">LinkedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a4046f4778cc038407a232aabde626003">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return head object pointer. <a href="#a4046f4778cc038407a232aabde626003"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a08fefd0d5005ccc89a232657aab2e2a7">operator*=</a> (<a class="el" href="a00099.html">OrderedObject</a> *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add object to our list. <a href="#a08fefd0d5005ccc89a232657aab2e2a7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c025143f811a31c84015ae7dbbccf6d"></a><!-- doxytag: member="OrderedIndex::OrderedIndex" ref="a1c025143f811a31c84015ae7dbbccf6d" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a1c025143f811a31c84015ae7dbbccf6d">OrderedIndex</a> ()</td></tr>
<tr><td class="mdescLeft"> </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="ac86380c8f929685758b892b25af7bd0a"></a><!-- doxytag: member="OrderedIndex::purge" ref="ac86380c8f929685758b892b25af7bd0a" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#ac86380c8f929685758b892b25af7bd0a">purge</a> (void)</td></tr>
<tr><td class="mdescLeft"> </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"><a class="anchor" id="ad5f9b2d1877c5521ab0464a02823b844"></a><!-- doxytag: member="OrderedIndex::reset" ref="ad5f9b2d1877c5521ab0464a02823b844" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#ad5f9b2d1877c5521ab0464a02823b844">reset</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset linked list to empty without purging. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a7916c04b5fbe4bf425cb2bdd1d07e7f9">unlock_index</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to synchronize lists managed by multiple threads. <a href="#a7916c04b5fbe4bf425cb2bdd1d07e7f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa0c7632a62886a8128cca4ce613b8cd"></a><!-- doxytag: member="OrderedIndex::~OrderedIndex" ref="aaa0c7632a62886a8128cca4ce613b8cd" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#aaa0c7632a62886a8128cca4ce613b8cd">~OrderedIndex</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy index. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb7c310f82b0ac36455639febf3c182c"></a><!-- doxytag: member="OrderedIndex::head" ref="aeb7c310f82b0ac36455639febf3c182c" args="" -->
<a class="el" href="a00099.html">OrderedObject</a> * </td><td class="memItemRight" valign="bottom"><b>head</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedce85f0348403a8cd4b9e6cd7620b4f"></a><!-- doxytag: member="OrderedIndex::tail" ref="aedce85f0348403a8cd4b9e6cd7620b4f" args="" -->
<a class="el" href="a00099.html">OrderedObject</a> * </td><td class="memItemRight" valign="bottom"><b>tail</b></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98e0d80baed2f0af623c216518687dba"></a><!-- doxytag: member="OrderedIndex::DLinkedObject" ref="a98e0d80baed2f0af623c216518687dba" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a98e0d80baed2f0af623c216518687dba">DLinkedObject</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af71fad9f4990e232af55c73aeddb3823"></a><!-- doxytag: member="OrderedIndex::LinkedList" ref="af71fad9f4990e232af55c73aeddb3823" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#af71fad9f4990e232af55c73aeddb3823">LinkedList</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff917ff3b53052c4f3f2481fb7d6908f"></a><!-- doxytag: member="OrderedIndex::NamedObject" ref="aff917ff3b53052c4f3f2481fb7d6908f" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#aff917ff3b53052c4f3f2481fb7d6908f">NamedObject</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0369fa20b5664238bd703d61ec455bd9"></a><!-- doxytag: member="OrderedIndex::OrderedObject" ref="a0369fa20b5664238bd703d61ec455bd9" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a0369fa20b5664238bd703d61ec455bd9">OrderedObject</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><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. Fundamental methods for supporting iterators are also provided. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="a00003.html#_a1">linked.cpp</a>.</p>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00187_source.html#l00175">175</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8fa77a4e85265a040f877625f08242aa"></a><!-- doxytag: member="OrderedIndex::add" ref="a8fa77a4e85265a040f877625f08242aa" args="(OrderedObject *ordered)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OrderedIndex::add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00099.html">OrderedObject</a> * </td>
<td class="paramname"><em>ordered</em></td><td>)</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 class="params">
<tr><td class="paramname">ordered</td><td>object to add to the index. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3a2267828b2a27933050009fa6dc5f35"></a><!-- doxytag: member="OrderedIndex::begin" ref="a3a2267828b2a27933050009fa6dc5f35" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00065.html">LinkedObject</a>* OrderedIndex::begin </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>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="a00187_source.html#l00263">263</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2d2f03c6b41c1d76dbf12768c872c632"></a><!-- doxytag: member="OrderedIndex::count" ref="a2d2f03c6b41c1d76dbf12768c872c632" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned OrderedIndex::count </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</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="a7eb0273007518790a22626de8fea9e59"></a><!-- doxytag: member="OrderedIndex::end" ref="a7eb0273007518790a22626de8fea9e59" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00065.html">LinkedObject</a>* OrderedIndex::end </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>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="a00187_source.html#l00270">270</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7cc5a22fd33044a20b0b63c166b77974"></a><!-- doxytag: member="OrderedIndex::find" ref="a7cc5a22fd33044a20b0b63c166b77974" args="(unsigned offset) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00065.html">LinkedObject</a>* OrderedIndex::find </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>offset</em></td><td>)</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 class="params">
<tr><td class="paramname">offset</td><td>to member to find. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa4e54d266fac3664cafc0d03804ad84d"></a><!-- doxytag: member="OrderedIndex::get" ref="aa4e54d266fac3664cafc0d03804ad84d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00065.html">LinkedObject</a>* OrderedIndex::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</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="a00065.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="ac7c483d8d3044906d92e379dd6d3a591"></a><!-- doxytag: member="OrderedIndex::getIndexed" ref="ac7c483d8d3044906d92e379dd6d3a591" args="(unsigned index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00065.html">LinkedObject</a>* OrderedIndex::getIndexed </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>index</em></td><td>)</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 class="params">
<tr><td class="paramname">index</td><td>of member to fetch. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="a00065.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="a00187_source.html#l00256">256</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="a00098_ac7c483d8d3044906d92e379dd6d3a591_cgraph.png" border="0" usemap="#a00098_ac7c483d8d3044906d92e379dd6d3a591_cgraph" alt=""/></div>
<map name="a00098_ac7c483d8d3044906d92e379dd6d3a591_cgraph" id="a00098_ac7c483d8d3044906d92e379dd6d3a591_cgraph">
<area shape="rect" id="node3" href="a00065.html#a06329b5408f6023ffbde442c0e0174c2" title="Get member by index." alt="" coords="319,5,580,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a84e274a96c88a579a4e27f32c781480f"></a><!-- doxytag: member="OrderedIndex::index" ref="a84e274a96c88a579a4e27f32c781480f" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00065.html">LinkedObject</a>** OrderedIndex::index </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</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="a00065.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="acfff06a41ca74c1ccecabb6ed32a44a5"></a><!-- doxytag: member="OrderedIndex::lock_index" ref="acfff06a41ca74c1ccecabb6ed32a44a5" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void OrderedIndex::lock_index </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</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="a4046f4778cc038407a232aabde626003"></a><!-- doxytag: member="OrderedIndex::operator*" ref="a4046f4778cc038407a232aabde626003" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00065.html">LinkedObject</a>* OrderedIndex::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</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="a00187_source.html#l00277">277</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a08fefd0d5005ccc89a232657aab2e2a7"></a><!-- doxytag: member="OrderedIndex::operator*=" ref="a08fefd0d5005ccc89a232657aab2e2a7" args="(OrderedObject *object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OrderedIndex::operator*= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00099.html">OrderedObject</a> * </td>
<td class="paramname"><em>object</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add object to our list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>to add. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7916c04b5fbe4bf425cb2bdd1d07e7f9"></a><!-- doxytag: member="OrderedIndex::unlock_index" ref="a7916c04b5fbe4bf425cb2bdd1d07e7f9" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void OrderedIndex::unlock_index </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</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="a00187_source.html">linked.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00098.html">OrderedIndex</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:48 for ucommon by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
