<!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::keylist< T > Class Template 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="a00058.html">keylist</a>
</div>
</div>
<div class="contents">
<h1>ucommon::keylist< T > Class Template Reference</h1><!-- doxytag: class="ucommon::keylist" --><!-- doxytag: inherits="ucommon::OrderedIndex" -->
<p>A template for ordered index of typed name key mapped 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::keylist< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00396.png" border="0" usemap="#ucommon_1_1keylist_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1keylist_3_01_t_01_4_inherit__map" id="ucommon_1_1keylist_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00100.html" title="An index container for maintaining an ordered list of objects." alt="" coords="5,5,237,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::keylist< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00397.png" border="0" usemap="#ucommon_1_1keylist_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1keylist_3_01_t_01_4_coll__map" id="ucommon_1_1keylist_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00100.html" title="An index container for maintaining an ordered list of objects." alt="" coords="15,280,247,307"/><area shape="rect" id="node4" href="a00101.html" title="A linked object base class for ordered objects." alt="" coords="9,176,252,203"/><area shape="rect" id="node6" 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="node8" 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">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#acaa91c66bfcd2134ae25649b3e2aab42">begin</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return first item in ordered list. <a href="#acaa91c66bfcd2134ae25649b3e2aab42"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#adbb683509e50e718d6b53a374095645c">create</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new typed named object with default constructor. <a href="#adbb683509e50e718d6b53a374095645c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#ab7e72c1e2ed62d0a8b2911f19bbbda02">end</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return last item in ordered list. <a href="#ab7e72c1e2ed62d0a8b2911f19bbbda02"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a4124e643e92cfa9e2f50b18f440cdaa8">find</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a specific object by name. <a href="#a4124e643e92cfa9e2f50b18f440cdaa8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a3535845a913c0065da644b16233369f4">index</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert our linked list into a linear object pointer array. <a href="#a3535845a913c0065da644b16233369f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a6c663be8319b31dd4fc0b719097101f4">next</a> (<a class="el" href="a00067.html">LinkedObject</a> *current)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate next object in list. <a href="#a6c663be8319b31dd4fc0b719097101f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bda430fe823ab34f13f004de18ad8dc"></a><!-- doxytag: member="ucommon::keylist::offset" ref="a0bda430fe823ab34f13f004de18ad8dc" args="(unsigned offset)" -->
T * </td><td class="memItemRight" valign="bottom"><b>offset</b> (unsigned offset)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c9899d3fac937ec7986cdc97695cfd7"></a><!-- doxytag: member="ucommon::keylist::operator[]" ref="a6c9899d3fac937ec7986cdc97695cfd7" args="(const char *name)" -->
T & </td><td class="memItemRight" valign="bottom"><b>operator[]</b> (const char *name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a270ab6f2c6034508819b7631de54e685">operator[]</a> (unsigned offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a specific object by position in list. <a href="#a270ab6f2c6034508819b7631de54e685"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00090.html">NamedObject</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#ab523a13ac68382a4aa7d172fdea2239d">root</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a root node pointer to use in <a class="el" href="a00090.html" title="A linked object base class with members found by name.">NamedObject</a> constructors. <a href="#ab523a13ac68382a4aa7d172fdea2239d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a30b7ac2ca4b6c2e970ac27a9cd03a4a7">sort</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert our linked list into an alphabetically sorted linear object pointer array. <a href="#a30b7ac2ca4b6c2e970ac27a9cd03a4a7"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br/>
class ucommon::keylist< T ></h3>
<p>A template for ordered index of typed name key mapped objects. </p>
<p>This is used to hold an iterable linked list of typed named objects where we can find objects by their name as well as through iteration. </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#l01838">1838</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acaa91c66bfcd2134ae25649b3e2aab42"></a><!-- doxytag: member="ucommon::keylist::begin" ref="acaa91c66bfcd2134ae25649b3e2aab42" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00058.html">ucommon::keylist</a>< T >::begin </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return first item in ordered list. </p>
<p>This is commonly used to iterate the list. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>first item in list or NULL if empty. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01853">1853</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="adbb683509e50e718d6b53a374095645c"></a><!-- doxytag: member="ucommon::keylist::create" ref="adbb683509e50e718d6b53a374095645c" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00058.html">ucommon::keylist</a>< T >::create </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new typed named object with default constructor. </p>
<p>This creates a new object which can be deleted. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of object to create. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>typed named object. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01870">1870</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab7e72c1e2ed62d0a8b2911f19bbbda02"></a><!-- doxytag: member="ucommon::keylist::end" ref="ab7e72c1e2ed62d0a8b2911f19bbbda02" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00058.html">ucommon::keylist</a>< T >::end </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return last item in ordered list. </p>
<p>This is commonly used to determine end of list iteration. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>last item in list or NULL if empty. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01861">1861</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4124e643e92cfa9e2f50b18f440cdaa8"></a><!-- doxytag: member="ucommon::keylist::find" ref="a4124e643e92cfa9e2f50b18f440cdaa8" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00058.html">ucommon::keylist</a>< T >::find </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find a specific object by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>to search for. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>type named object that matches or NULL if not found. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01886">1886</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3535845a913c0065da644b16233369f4"></a><!-- doxytag: member="ucommon::keylist::index" ref="a3535845a913c0065da644b16233369f4" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T** <a class="el" href="a00058.html">ucommon::keylist</a>< T >::index </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert our linked list into a linear object pointer array. </p>
<p>The object pointer array is created from the heap and must be deleted when no longer used. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>array of typed named object pointers. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01909">1909</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6c663be8319b31dd4fc0b719097101f4"></a><!-- doxytag: member="ucommon::keylist::next" ref="a6c663be8319b31dd4fc0b719097101f4" args="(LinkedObject *current)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00058.html">ucommon::keylist</a>< T >::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00067.html">LinkedObject</a> * </td>
<td class="paramname"> <em>current</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate next object in 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>current</em> </td><td>object we are referencing. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>next logical object in linked list or NULL if end. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01878">1878</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00058_a6c663be8319b31dd4fc0b719097101f4_cgraph.png" border="0" usemap="#a00058_a6c663be8319b31dd4fc0b719097101f4_cgraph_map" alt=""></div>
<map name="a00058_a6c663be8319b31dd4fc0b719097101f4_cgraph_map" id="a00058_a6c663be8319b31dd4fc0b719097101f4_cgraph">
<area shape="rect" id="node3" href="a00067.html#a04d24fc1e0319ec60206831ff467f73a" title="Get next effective object when iterating." alt="" coords="296,5,619,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a270ab6f2c6034508819b7631de54e685"></a><!-- doxytag: member="ucommon::keylist::operator[]" ref="a270ab6f2c6034508819b7631de54e685" args="(unsigned offset)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="a00058.html">ucommon::keylist</a>< T >::operator[] </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>offset</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve a specific object by position in 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> </td><td>in list for object we want. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>type named object or NULL if past end of list. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01897">1897</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab523a13ac68382a4aa7d172fdea2239d"></a><!-- doxytag: member="ucommon::keylist::root" ref="ab523a13ac68382a4aa7d172fdea2239d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00090.html">NamedObject</a>** <a class="el" href="a00058.html">ucommon::keylist</a>< T >::root </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a root node pointer to use in <a class="el" href="a00090.html" title="A linked object base class with members found by name.">NamedObject</a> constructors. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to index root. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01845">1845</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a30b7ac2ca4b6c2e970ac27a9cd03a4a7"></a><!-- doxytag: member="ucommon::keylist::sort" ref="a30b7ac2ca4b6c2e970ac27a9cd03a4a7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T** <a class="el" href="a00058.html">ucommon::keylist</a>< T >::sort </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert our linked list into an alphabetically sorted linear object pointer array. </p>
<p>The object pointer array is created from the heap and must be deleted when no longer used. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>array of typed named object pointers. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01918">1918</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:38 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>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
4f5f2dc0f55b453456458df885792b0b
>
files
>
120
