<!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: keymap< T, M > Class Template 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('a00058.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>keymap< T, M > Class Template Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="keymap" -->
<p>A template class for a hash map.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00187_source.html">linked.h</a>></code></p>
<div class="dynheader">
Collaboration diagram for keymap< T, M >:</div>
<div class="dyncontent">
<div class="center"><img src="a00332.png" border="0" usemap="#keymap_3_01_t_00_01_m_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="keymap_3_01_t_00_01_m_01_4_coll__map" id="keymap_3_01_t_00_01_m_01_4_coll__map">
<area shape="rect" id="node2" href="a00088.html" title="A linked object base class with members found by name." alt="" coords="21,253,152,280"/><area shape="rect" id="node4" href="a00099.html" title="A linked object base class for ordered objects." alt="" coords="11,176,163,203"/><area shape="rect" id="node6" href="a00065.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="16,91,157,117"/><area shape="rect" id="node8" href="a00091.html" title="A common base class for all managed objects." alt="" coords="45,5,128,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="a00058.html#aa941f8d878c39793bd8a0f3f385621d0">add</a> (const char *name, T &object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a typed object derived from <a class="el" href="a00088.html" title="A linked object base class with members found by name.">NamedObject</a> to the hash map by name. <a href="#aa941f8d878c39793bd8a0f3f385621d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a8850a77c48dfd2cfe0411ae397d39136">add</a> (const char *name, T *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a typed object derived from <a class="el" href="a00088.html" title="A linked object base class with members found by name.">NamedObject</a> to the hash map by name. <a href="#a8850a77c48dfd2cfe0411ae397d39136"></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#ae515f25820024fe46bdf182d4f0820a8">begin</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find first typed object in hash map to iterate. <a href="#ae515f25820024fe46bdf182d4f0820a8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#aba9bb0edf9300bdebd1cc679ae6d2f3b">count</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Count the number of typed objects in our hash map. <a href="#aba9bb0edf9300bdebd1cc679ae6d2f3b"></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#a420b9cd81f5937275a24cf9c136fb297">get</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a typed object derived from <a class="el" href="a00088.html" title="A linked object base class with members found by name.">NamedObject</a> in the hash map by name. <a href="#a420b9cd81f5937275a24cf9c136fb297"></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#a6f125f7571b244a6aed1505573090acd">index</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert our hash map into a linear object pointer array. <a href="#a6f125f7571b244a6aed1505573090acd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a2a83c4dab062bbb5445fb1e01a0a1876">limit</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve key size to use in <a class="el" href="a00088.html" title="A linked object base class with members found by name.">NamedObject</a> constructors. <a href="#a2a83c4dab062bbb5445fb1e01a0a1876"></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#a53d1867cae178c13bf64282db94ec36a">next</a> (T *current) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find next typed object in hash map for iteration. <a href="#a53d1867cae178c13bf64282db94ec36a"></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#aab9c56044b931d46110024d62d2d8bb5">operator[]</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a typed object derived from <a class="el" href="a00088.html" title="A linked object base class with members found by name.">NamedObject</a> in the hash map by name. <a href="#aab9c56044b931d46110024d62d2d8bb5"></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#aae9471602750846cdb8969540c90340a">remove</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a typed object derived from <a class="el" href="a00088.html" title="A linked object base class with members found by name.">NamedObject</a> to the hash map by name. <a href="#aae9471602750846cdb8969540c90340a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00088.html">NamedObject</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a1c06d836b11878279061fb06eb2c2ef4">root</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve root of index to use in <a class="el" href="a00088.html" title="A linked object base class with members found by name.">NamedObject</a> constructors. <a href="#a1c06d836b11878279061fb06eb2c2ef4"></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#a512a115f7a8ba97fb092923b31c456ad">sort</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert our hash map into an alphabetically sorted linear object pointer array. <a href="#a512a115f7a8ba97fb092923b31c456ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33d5846e28bd010d5e510f58e2ddd232"></a><!-- doxytag: member="keymap::~keymap" ref="a33d5846e28bd010d5e510f58e2ddd232" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html#a33d5846e28bd010d5e510f58e2ddd232">~keymap</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the hash map by puring the index chains. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class T, unsigned M = 177><br/>
class keymap< T, M ></h3>
<p>A template class for a hash map. </p>
<p>This provides a has map index object as a chain of keyindex selected linked pointers of a specified size. This is used for the index and size values for NamedObject's which are listed on a hash map. </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="a00187_source.html#l01716">1716</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="aa941f8d878c39793bd8a0f3f385621d0"></a><!-- doxytag: member="keymap::add" ref="aa941f8d878c39793bd8a0f3f385621d0" args="(const char *name, T &object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , unsigned M = 177> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00058.html">keymap</a>< T, M >::add </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">T & </td>
<td class="paramname"><em>object</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a typed object derived from <a class="el" href="a00088.html" title="A linked object base class with members found by name.">NamedObject</a> to the hash map by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>to add. </td></tr>
<tr><td class="paramname">object</td><td>to add. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01763">1763</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8850a77c48dfd2cfe0411ae397d39136"></a><!-- doxytag: member="keymap::add" ref="a8850a77c48dfd2cfe0411ae397d39136" args="(const char *name, T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , unsigned M = 177> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00058.html">keymap</a>< T, M >::add </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">T * </td>
<td class="paramname"><em>object</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a typed object derived from <a class="el" href="a00088.html" title="A linked object base class with members found by name.">NamedObject</a> to the hash map by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>to add. </td></tr>
<tr><td class="paramname">object</td><td>to add. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01771">1771</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae515f25820024fe46bdf182d4f0820a8"></a><!-- doxytag: member="keymap::begin" ref="ae515f25820024fe46bdf182d4f0820a8" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , unsigned M = 177> </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00058.html">keymap</a>< T, M >::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>Find first typed object in hash map to iterate. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>first typed object or NULL if nothing in list. </dd></dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01786">1786</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="a00058_ae515f25820024fe46bdf182d4f0820a8_cgraph.png" border="0" usemap="#a00058_ae515f25820024fe46bdf182d4f0820a8_cgraph" alt=""/></div>
<map name="a00058_ae515f25820024fe46bdf182d4f0820a8_cgraph" id="a00058_ae515f25820024fe46bdf182d4f0820a8_cgraph">
<area shape="rect" id="node3" href="a00088.html#a89089e45e4a010050238d330f46d8ab2" title="Iterate through a hash map table." alt="" coords="205,5,397,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aba9bb0edf9300bdebd1cc679ae6d2f3b"></a><!-- doxytag: member="keymap::count" ref="aba9bb0edf9300bdebd1cc679ae6d2f3b" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , unsigned M = 177> </div>
<table class="memname">
<tr>
<td class="memname">unsigned <a class="el" href="a00058.html">keymap</a>< T, M >::count </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>Count the number of typed objects in our hash map. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>count of typed objects. </dd></dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01801">1801</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a420b9cd81f5937275a24cf9c136fb297"></a><!-- doxytag: member="keymap::get" ref="a420b9cd81f5937275a24cf9c136fb297" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , unsigned M = 177> </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00058.html">keymap</a>< T, M >::get </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>Find a typed object derived from <a class="el" href="a00088.html" title="A linked object base class with members found by name.">NamedObject</a> in the hash map by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>to search for. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>typed object if found through map or NULL. </dd></dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01747">1747</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="a00058_a420b9cd81f5937275a24cf9c136fb297_cgraph.png" border="0" usemap="#a00058_a420b9cd81f5937275a24cf9c136fb297_cgraph" alt=""/></div>
<map name="a00058_a420b9cd81f5937275a24cf9c136fb297_cgraph" id="a00058_a420b9cd81f5937275a24cf9c136fb297_cgraph">
<area shape="rect" id="node3" href="a00088.html#a43a968cead56c2d456bf61caef8b9294" title="Find a named object through a hash map table." alt="" coords="188,5,369,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a6f125f7571b244a6aed1505573090acd"></a><!-- doxytag: member="keymap::index" ref="a6f125f7571b244a6aed1505573090acd" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , unsigned M = 177> </div>
<table class="memname">
<tr>
<td class="memname">T** <a class="el" href="a00058.html">keymap</a>< T, M >::index </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>Convert our hash map 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="a00187_source.html#l01810">1810</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2a83c4dab062bbb5445fb1e01a0a1876"></a><!-- doxytag: member="keymap::limit" ref="a2a83c4dab062bbb5445fb1e01a0a1876" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , unsigned M = 177> </div>
<table class="memname">
<tr>
<td class="memname">unsigned <a class="el" href="a00058.html">keymap</a>< T, M >::limit </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>Retrieve key size to use in <a class="el" href="a00088.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>key size of hash map. </dd></dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01739">1739</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a53d1867cae178c13bf64282db94ec36a"></a><!-- doxytag: member="keymap::next" ref="a53d1867cae178c13bf64282db94ec36a" args="(T *current) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , unsigned M = 177> </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00058.html">keymap</a>< T, M >::next </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>current</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find next typed object in hash map for iteration. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">current</td><td>typed object we are referencing. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>next iterative object or NULL if past end of map. </dd></dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01794">1794</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="a00058_a53d1867cae178c13bf64282db94ec36a_cgraph.png" border="0" usemap="#a00058_a53d1867cae178c13bf64282db94ec36a_cgraph" alt=""/></div>
<map name="a00058_a53d1867cae178c13bf64282db94ec36a_cgraph" id="a00058_a53d1867cae178c13bf64282db94ec36a_cgraph">
<area shape="rect" id="node3" href="a00088.html#a89089e45e4a010050238d330f46d8ab2" title="Iterate through a hash map table." alt="" coords="197,5,389,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aab9c56044b931d46110024d62d2d8bb5"></a><!-- doxytag: member="keymap::operator[]" ref="aab9c56044b931d46110024d62d2d8bb5" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , unsigned M = 177> </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="a00058.html">keymap</a>< T, M >::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>Find a typed object derived from <a class="el" href="a00088.html" title="A linked object base class with members found by name.">NamedObject</a> in the hash map by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>to search for. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>typed object if found through map or NULL. </dd></dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01755">1755</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="a00058_aab9c56044b931d46110024d62d2d8bb5_cgraph.png" border="0" usemap="#a00058_aab9c56044b931d46110024d62d2d8bb5_cgraph" alt=""/></div>
<map name="a00058_aab9c56044b931d46110024d62d2d8bb5_cgraph" id="a00058_aab9c56044b931d46110024d62d2d8bb5_cgraph">
<area shape="rect" id="node3" href="a00088.html#a43a968cead56c2d456bf61caef8b9294" title="Find a named object through a hash map table." alt="" coords="257,5,439,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aae9471602750846cdb8969540c90340a"></a><!-- doxytag: member="keymap::remove" ref="aae9471602750846cdb8969540c90340a" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , unsigned M = 177> </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00058.html">keymap</a>< T, M >::remove </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>Remove a typed object derived from <a class="el" href="a00088.html" title="A linked object base class with members found by name.">NamedObject</a> to the hash map by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>to remove. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>object removed if found or NULL. </dd></dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01779">1779</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1c06d836b11878279061fb06eb2c2ef4"></a><!-- doxytag: member="keymap::root" ref="a1c06d836b11878279061fb06eb2c2ef4" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , unsigned M = 177> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00088.html">NamedObject</a>** <a class="el" href="a00058.html">keymap</a>< T, M >::root </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>Retrieve root of index to use in <a class="el" href="a00088.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>root node of index. </dd></dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01732">1732</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a512a115f7a8ba97fb092923b31c456ad"></a><!-- doxytag: member="keymap::sort" ref="a512a115f7a8ba97fb092923b31c456ad" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , unsigned M = 177> </div>
<table class="memname">
<tr>
<td class="memname">T** <a class="el" href="a00058.html">keymap</a>< T, M >::sort </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>Convert our hash map 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>sorted array of typed named object pointers. </dd></dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01819">1819</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="a00058_a512a115f7a8ba97fb092923b31c456ad_cgraph.png" border="0" usemap="#a00058_a512a115f7a8ba97fb092923b31c456ad_cgraph" alt=""/></div>
<map name="a00058_a512a115f7a8ba97fb092923b31c456ad_cgraph" id="a00058_a512a115f7a8ba97fb092923b31c456ad_cgraph">
<area shape="rect" id="node3" href="a00088.html#ac4813f0fef5c120b9cfcae00bbe00e43" title="Convert a hash index into a linear object pointer array." alt="" coords="197,5,400,32"/></map>
</div>
</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="a00058.html">keymap</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:47 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>
