<!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::NamedObject 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 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="a00090.html">NamedObject</a>
</div>
</div>
<div class="contents">
<h1>ucommon::NamedObject Class Reference</h1><!-- doxytag: class="ucommon::NamedObject" --><!-- doxytag: inherits="ucommon::OrderedObject" -->
<p>A linked object base class with members found by name.
<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::NamedObject:</div>
<div class="dynsection">
<div class="center"><img src="a00450.png" border="0" usemap="#ucommon_1_1_named_object_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1_named_object_inherit__map" id="ucommon_1_1_named_object_inherit__map">
<area shape="rect" id="node9" href="a00091.html" title="The named tree class is used to form a tree oriented list of associated objects." alt="" coords="29,304,232,331"/><area shape="rect" id="node2" href="a00101.html" title="A linked object base class for ordered objects." alt="" coords="9,155,252,181"/><area shape="rect" id="node4" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="15,80,247,107"/><area shape="rect" id="node6" href="a00095.html" title="A common base class for all managed objects." alt="" coords="5,5,256,32"/><area shape="rect" id="node11" href="a00166.html" title="Embed data objects into a tree structured memory database." alt="" coords="15,379,247,405"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::NamedObject:</div>
<div class="dynsection">
<div class="center"><img src="a00451.png" border="0" usemap="#ucommon_1_1_named_object_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1_named_object_coll__map" id="ucommon_1_1_named_object_coll__map">
<area shape="rect" id="node2" href="a00101.html" title="A linked object base class for ordered objects." alt="" coords="9,176,252,203"/><area shape="rect" id="node4" 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="node6" 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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a6f6858053b25b72985a5b190fb9a3b1a">add</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, char *name, unsigned size=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add object to hash indexed list. <a href="#a6f6858053b25b72985a5b190fb9a3b1a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a732f819ae0cf237ac1e9ad903de6162a">compare</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare the name of our object to see if equal. <a href="#a732f819ae0cf237ac1e9ad903de6162a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a305b35c947b5a271fb4c9136313bcff4">equal</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equal function which calls compare. <a href="#a305b35c947b5a271fb4c9136313bcff4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#ab95639df26135746d097fa7368396c00">getId</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the named id string of this object. <a href="#ab95639df26135746d097fa7368396c00"></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="a00090.html#a64f5e6ff6811af6cbf8d0f94628e44c9">getNext</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get next effective object when iterating. <a href="#a64f5e6ff6811af6cbf8d0f94628e44c9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a10b287fc87ccb3fddef98c7d30bb6296">operator!=</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator between our name and a string. <a href="#a10b287fc87ccb3fddef98c7d30bb6296"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a36aa641dbcb2545f58c30cc61f1bc278">operator==</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator between our name and a string. <a href="#a36aa641dbcb2545f58c30cc61f1bc278"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a55e0e2538e977950668949ed51765f2f">count</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Count the total named objects in a hash table. <a href="#a55e0e2538e977950668949ed51765f2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a10a29898f401643bb8c11b5502b2b4d5">find</a> (<a class="el" href="a00090.html">NamedObject</a> *root, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a named object from a simple list. <a href="#a10a29898f401643bb8c11b5502b2b4d5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a49c8123dfb9f616e593f358220c68f09">index</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a hash index into a linear object pointer array. <a href="#a49c8123dfb9f616e593f358220c68f09"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a1c0358696080e53e31bfd105a4082b8e">keyindex</a> (const char *name, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal function to convert a name to a hash index number. <a href="#a1c0358696080e53e31bfd105a4082b8e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#afda0ea5f949aaaf32a763992eb822787">map</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, const char *name, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a named object through a hash map table. <a href="#afda0ea5f949aaaf32a763992eb822787"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a8eaab18759a49433e2ed24f63944534a">purge</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Purge a hash indexed table of named objects. <a href="#a8eaab18759a49433e2ed24f63944534a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#ad1448ab1d56411ec84d8efd51cfa3af6">remove</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, const char *name, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove an object from a hash map table. <a href="#ad1448ab1d56411ec84d8efd51cfa3af6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a4a73b0643419b26122ea188317e292dd">remove</a> (<a class="el" href="a00090.html">NamedObject</a> **root, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a named object from a simple list. <a href="#a4a73b0643419b26122ea188317e292dd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#af593069d39d2f39dbd9712ac089446b4">skip</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, <a class="el" href="a00090.html">NamedObject</a> *current, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate through a hash map table. <a href="#af593069d39d2f39dbd9712ac089446b4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a06e5dbd280853c992bb8e5fcc6a2a189">sort</a> (<a class="el" href="a00090.html">NamedObject</a> **list, size_t count=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sort an array of named objects in alphabetical order. <a href="#a06e5dbd280853c992bb8e5fcc6a2a189"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#acf4d6f722d9fe0498f3e138bce87d1eb">clearId</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The behavior of clearing id's can be overridden if they are not assigned as strdup's from the heap. <a href="#acf4d6f722d9fe0498f3e138bce87d1eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#abd66aedc5dbfce5082eacfbab95229a9">NamedObject</a> (<a class="el" href="a00100.html">OrderedIndex</a> *index, char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Created a named object on an ordered list. <a href="#abd66aedc5dbfce5082eacfbab95229a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#af5d6738491f924e243db5f5d498b1b4e">NamedObject</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, char *name, unsigned size=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a named object and add to hash indexed list. <a href="#af5d6738491f924e243db5f5d498b1b4e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a162e4114539f1e7315b9239c0a346aae"></a><!-- doxytag: member="ucommon::NamedObject::NamedObject" ref="a162e4114539f1e7315b9239c0a346aae" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a162e4114539f1e7315b9239c0a346aae">NamedObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty unnamed cell object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a3766cbcab21b5fbf2054f649a66b4645">~NamedObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy named object. <a href="#a3766cbcab21b5fbf2054f649a66b4645"></a><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="a654b4080bfc46f41aa75543edb927a3d"></a><!-- doxytag: member="ucommon::NamedObject::id" ref="a654b4080bfc46f41aa75543edb927a3d" args="" -->
char * </td><td class="memItemRight" valign="bottom"><b>id</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A linked object base class with members found by name. </p>
<p>This class is used to help form named option lists and other forms of name indexed associative data structures. The id is assumed to be passed from a dupped or dynamically allocated string. If a constant string is used then you must not call delete for this object.</p>
<p>Named objects are either listed on an ordered list or keyed through an associate hash map table. When using a hash table, the name id string is used to determine the slot number to use in a list of n sized linked object lists. Hence, a hash index refers to a specific sized array of object indexes. </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#l00384">384</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af5d6738491f924e243db5f5d498b1b4e"></a><!-- doxytag: member="ucommon::NamedObject::NamedObject" ref="af5d6738491f924e243db5f5d498b1b4e" args="(NamedObject **hash, char *name, unsigned size=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::NamedObject::NamedObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em> = <code>1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a named object and add to hash indexed 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>hash</em> </td><td>map table to list node on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of the object we are listing. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abd66aedc5dbfce5082eacfbab95229a9"></a><!-- doxytag: member="ucommon::NamedObject::NamedObject" ref="abd66aedc5dbfce5082eacfbab95229a9" args="(OrderedIndex *index, char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::NamedObject::NamedObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00100.html">OrderedIndex</a> * </td>
<td class="paramname"> <em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Created a named object on an ordered list. </p>
<p>This is commonly used to form attribute lists. </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> </td><td>to list object on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of the object we are listing. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3766cbcab21b5fbf2054f649a66b4645"></a><!-- doxytag: member="ucommon::NamedObject::~NamedObject" ref="a3766cbcab21b5fbf2054f649a66b4645" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::NamedObject::~NamedObject </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy named object. </p>
<p>We do not always destroy named objects, since we may use them in reusable pools or we may initialize a list that we keep permanently. If we do invoke delete for something based on <a class="el" href="a00090.html" title="A linked object base class with members found by name.">NamedObject</a>, then be aware the object id is assumed to be formed from a dup'd string which will also be freed unless clearId is overridden. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6f6858053b25b72985a5b190fb9a3b1a"></a><!-- doxytag: member="ucommon::NamedObject::add" ref="a6f6858053b25b72985a5b190fb9a3b1a" args="(NamedObject **hash, char *name, unsigned size=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::NamedObject::add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em> = <code>1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add object to hash indexed 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>hash</em> </td><td>map table to list node on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of the object we are listing. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acf4d6f722d9fe0498f3e138bce87d1eb"></a><!-- doxytag: member="ucommon::NamedObject::clearId" ref="acf4d6f722d9fe0498f3e138bce87d1eb" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ucommon::NamedObject::clearId </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The behavior of clearing id's can be overridden if they are not assigned as strdup's from the heap. </p>
<p>.. </p>
</div>
</div>
<a class="anchor" id="a732f819ae0cf237ac1e9ad903de6162a"></a><!-- doxytag: member="ucommon::NamedObject::compare" ref="a732f819ae0cf237ac1e9ad903de6162a" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int ucommon::NamedObject::compare </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare the name of our object to see if equal. </p>
<p>This is a virtual so that it can be overridden when using named lists or hash lookups that must be case insensitive. </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 compare our name to. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if effectivily equal, used for sorting keys. </dd></dl>
</div>
</div>
<a class="anchor" id="a55e0e2538e977950668949ed51765f2f"></a><!-- doxytag: member="ucommon::NamedObject::count" ref="a55e0e2538e977950668949ed51765f2f" args="(NamedObject **hash, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static unsigned ucommon::NamedObject::count </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Count the total named objects in a hash table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table of objects to index. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a305b35c947b5a271fb4c9136313bcff4"></a><!-- doxytag: member="ucommon::NamedObject::equal" ref="a305b35c947b5a271fb4c9136313bcff4" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucommon::NamedObject::equal </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Equal function which calls compare. </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 compare our name to. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if equal. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00546">546</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a10a29898f401643bb8c11b5502b2b4d5"></a><!-- doxytag: member="ucommon::NamedObject::find" ref="a10a29898f401643bb8c11b5502b2b4d5" args="(NamedObject *root, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>* ucommon::NamedObject::find </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> * </td>
<td class="paramname"> <em>root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find a named object from a simple list. </p>
<p>This may also use the begin() member of an ordered index of named objects. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>root</em> </td><td>node of named object list. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of object to find. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>object pointer or NULL if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="ab95639df26135746d097fa7368396c00"></a><!-- doxytag: member="ucommon::NamedObject::getId" ref="ab95639df26135746d097fa7368396c00" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* ucommon::NamedObject::getId </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>Get the named id string of this object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>name id. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00529">529</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a64f5e6ff6811af6cbf8d0f94628e44c9"></a><!-- doxytag: member="ucommon::NamedObject::getNext" ref="a64f5e6ff6811af6cbf8d0f94628e44c9" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00090.html">NamedObject</a>* ucommon::NamedObject::getNext </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>Get next effective object when iterating. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next linked object in list. </dd></dl>
<p>Reimplemented from <a class="el" href="a00101.html#af272ffa8eee0c8f4297df4cc4d2f0c27">ucommon::OrderedObject</a>.</p>
<p>Definition at line <a class="el" href="a00188_source.html#l00522">522</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a49c8123dfb9f616e593f358220c68f09"></a><!-- doxytag: member="ucommon::NamedObject::index" ref="a49c8123dfb9f616e593f358220c68f09" args="(NamedObject **hash, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>** ucommon::NamedObject::index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a hash index 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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table of objects to index. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table used. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>array of named object pointers. </dd></dl>
</div>
</div>
<a class="anchor" id="a1c0358696080e53e31bfd105a4082b8e"></a><!-- doxytag: member="ucommon::NamedObject::keyindex" ref="a1c0358696080e53e31bfd105a4082b8e" args="(const char *name, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static unsigned ucommon::NamedObject::keyindex </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Internal function to convert a name to a hash index number. </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 convert into index. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of map table. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afda0ea5f949aaaf32a763992eb822787"></a><!-- doxytag: member="ucommon::NamedObject::map" ref="afda0ea5f949aaaf32a763992eb822787" args="(NamedObject **hash, const char *name, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>* ucommon::NamedObject::map </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find a named object through a hash map table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table of objects to search. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of object to find. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>object pointer or NULL if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="a10b287fc87ccb3fddef98c7d30bb6296"></a><!-- doxytag: member="ucommon::NamedObject::operator!=" ref="a10b287fc87ccb3fddef98c7d30bb6296" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucommon::NamedObject::operator!= </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Comparison operator between our name and a string. </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 compare with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if not equal. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00562">562</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a36aa641dbcb2545f58c30cc61f1bc278"></a><!-- doxytag: member="ucommon::NamedObject::operator==" ref="a36aa641dbcb2545f58c30cc61f1bc278" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucommon::NamedObject::operator== </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Comparison operator between our name and a string. </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 compare with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if equal. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00554">554</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8eaab18759a49433e2ed24f63944534a"></a><!-- doxytag: member="ucommon::NamedObject::purge" ref="a8eaab18759a49433e2ed24f63944534a" args="(NamedObject **hash, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void ucommon::NamedObject::purge </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Purge a hash indexed table of named objects. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table to purge. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad1448ab1d56411ec84d8efd51cfa3af6"></a><!-- doxytag: member="ucommon::NamedObject::remove" ref="ad1448ab1d56411ec84d8efd51cfa3af6" args="(NamedObject **hash, const char *name, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>* ucommon::NamedObject::remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove an object from a hash map table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table of object to remove from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of object to remove. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>object that is removed or NULL if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="a4a73b0643419b26122ea188317e292dd"></a><!-- doxytag: member="ucommon::NamedObject::remove" ref="a4a73b0643419b26122ea188317e292dd" args="(NamedObject **root, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>* ucommon::NamedObject::remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove a named object from a simple 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>root</em> </td><td>node of named object list. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of object to find. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>object pointer or NULL if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="af593069d39d2f39dbd9712ac089446b4"></a><!-- doxytag: member="ucommon::NamedObject::skip" ref="af593069d39d2f39dbd9712ac089446b4" args="(NamedObject **hash, NamedObject *current, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>* ucommon::NamedObject::skip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> * </td>
<td class="paramname"> <em>current</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate through a hash map table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table to iterate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>current</em> </td><td>named object we iterated or NULL to find start of list. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of map table. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>next named object in hash map or NULL if no more objects. </dd></dl>
</div>
</div>
<a class="anchor" id="a06e5dbd280853c992bb8e5fcc6a2a189"></a><!-- doxytag: member="ucommon::NamedObject::sort" ref="a06e5dbd280853c992bb8e5fcc6a2a189" args="(NamedObject **list, size_t count=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>** ucommon::NamedObject::sort </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>count</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sort an array of named objects in alphabetical order. </p>
<p>This would typically be used to sort a list created and returned by <a class="el" href="a00090.html#a49c8123dfb9f616e593f358220c68f09" title="Convert a hash index into a linear object pointer array.">index()</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>of named objects to sort. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>of objects in the list or 0 to find by NULL pointer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>list in sorted order. </dd></dl>
</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:47 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
>
188
