/usr/share/doc/libucommon-dev/a00063.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 | <!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::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="a00214.html">ucc</a>::<a class="el" href="a00063.html">keylist</a>
</div>
</div>
<div class="contents">
<h1>ucc::keylist< T > Class Template Reference</h1><!-- doxytag: class="ucc::keylist" --><!-- doxytag: inherits="ucc::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="a00195_source.html">linked.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::keylist< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00408.png" border="0" usemap="#ucc_1_1keylist_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1keylist_3_01_t_01_4_inherit__map" id="ucc_1_1keylist_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="5,5,144,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::keylist< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00409.png" border="0" usemap="#ucc_1_1keylist_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1keylist_3_01_t_01_4_coll__map" id="ucc_1_1keylist_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="8,299,147,328"/><area shape="rect" id="node4" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="5,187,149,216"/><area shape="rect" id="node6" 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="node8" 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">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00063.html#a719cce3456c448ec8a81198f21d1f19c">begin</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return first item in ordered list. <a href="#a719cce3456c448ec8a81198f21d1f19c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00063.html#a5a8bd3b2172114642d37f0becfea1a1d">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="#a5a8bd3b2172114642d37f0becfea1a1d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00063.html#a7e12873a37972dd655ea25ea2f4d373a">end</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return last item in ordered list. <a href="#a7e12873a37972dd655ea25ea2f4d373a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00063.html#ae4df0ba0f5be80d59e02a5dbebd8bbc5">find</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a specific object by name. <a href="#ae4df0ba0f5be80d59e02a5dbebd8bbc5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00063.html#a72e10cff96ff02ddb8b2c0417dad4984">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="#a72e10cff96ff02ddb8b2c0417dad4984"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00063.html#a899373679b202e86bd13b688175ce775">next</a> (<a class="el" href="a00069.html">LinkedObject</a> *current)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate next object in list. <a href="#a899373679b202e86bd13b688175ce775"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00063.html#a94ca22c999a1666fdfe2491bc329a8e3">operator[]</a> (unsigned offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a specific object by position in list. <a href="#a94ca22c999a1666fdfe2491bc329a8e3"></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="a00063.html#aee8a5a1de04c840b1f8095dd9611d209">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="#aee8a5a1de04c840b1f8095dd9611d209"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00063.html#a57e0b02ced701931e272c7cd9d6da447">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="#a57e0b02ced701931e272c7cd9d6da447"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br/>
class ucc::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="a00195_source.html#l01826">1826</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a719cce3456c448ec8a81198f21d1f19c"></a><!-- doxytag: member="ucc::keylist::begin" ref="a719cce3456c448ec8a81198f21d1f19c" 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="a00063.html">ucc::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="a00195_source.html#l01841">1841</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5a8bd3b2172114642d37f0becfea1a1d"></a><!-- doxytag: member="ucc::keylist::create" ref="a5a8bd3b2172114642d37f0becfea1a1d" 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="a00063.html">ucc::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="a00195_source.html#l01858">1858</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7e12873a37972dd655ea25ea2f4d373a"></a><!-- doxytag: member="ucc::keylist::end" ref="a7e12873a37972dd655ea25ea2f4d373a" 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="a00063.html">ucc::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="a00195_source.html#l01849">1849</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae4df0ba0f5be80d59e02a5dbebd8bbc5"></a><!-- doxytag: member="ucc::keylist::find" ref="ae4df0ba0f5be80d59e02a5dbebd8bbc5" 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="a00063.html">ucc::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="a00195_source.html#l01874">1874</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a72e10cff96ff02ddb8b2c0417dad4984"></a><!-- doxytag: member="ucc::keylist::index" ref="a72e10cff96ff02ddb8b2c0417dad4984" 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="a00063.html">ucc::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="a00195_source.html#l01891">1891</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a899373679b202e86bd13b688175ce775"></a><!-- doxytag: member="ucc::keylist::next" ref="a899373679b202e86bd13b688175ce775" 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="a00063.html">ucc::keylist</a>< T >::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00069.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="a00195_source.html#l01866">1866</a> of file <a class="el" href="a00195_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="a00063_a899373679b202e86bd13b688175ce775_cgraph.png" border="0" usemap="#a00063_a899373679b202e86bd13b688175ce775_cgraph_map" alt=""></div>
<map name="a00063_a899373679b202e86bd13b688175ce775_cgraph_map" id="a00063_a899373679b202e86bd13b688175ce775_cgraph">
<area shape="rect" id="node3" href="a00069.html#acc25bd6615a2163028724910135b2cd2" title="Get next effective object when iterating." alt="" coords="183,5,375,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a94ca22c999a1666fdfe2491bc329a8e3"></a><!-- doxytag: member="ucc::keylist::operator[]" ref="a94ca22c999a1666fdfe2491bc329a8e3" 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="a00063.html">ucc::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="a00195_source.html#l01882">1882</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="aee8a5a1de04c840b1f8095dd9611d209"></a><!-- doxytag: member="ucc::keylist::root" ref="aee8a5a1de04c840b1f8095dd9611d209" 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="a00063.html">ucc::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="a00195_source.html#l01833">1833</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a57e0b02ced701931e272c7cd9d6da447"></a><!-- doxytag: member="ucc::keylist::sort" ref="a57e0b02ced701931e272c7cd9d6da447" 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="a00063.html">ucc::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="a00195_source.html#l01900">1900</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:31 2010 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>
|