<!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::keypager< T, M > 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="a00060.html">keypager</a>
</div>
</div>
<div class="contents">
<h1>ucommon::keypager< T, M > Class Template Reference</h1><!-- doxytag: class="ucommon::keypager" --><!-- doxytag: inherits="ucommon::mempager" -->
<p>A template class for a hash pager.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00190_source.html">memory.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::keypager< T, M >:</div>
<div class="dynsection">
<div class="center"><img src="a00399.png" border="0" usemap="#ucommon_1_1keypager_3_01_t_00_01_m_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1keypager_3_01_t_00_01_m_01_4_inherit__map" id="ucommon_1_1keypager_3_01_t_00_01_m_01_4_inherit__map">
<area shape="rect" id="node2" href="a00081.html" title="A managed private heap for small allocations." alt="" coords="45,155,237,181"/><area shape="rect" id="node4" href="a00079.html" title="A memory protocol pager for private heap manager." alt="" coords="45,80,237,107"/><area shape="rect" id="node6" href="a00073.html" title="Common locking protocol." alt="" coords="11,5,272,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::keypager< T, M >:</div>
<div class="dynsection">
<div class="center"><img src="a00400.png" border="0" usemap="#ucommon_1_1keypager_3_01_t_00_01_m_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1keypager_3_01_t_00_01_m_01_4_coll__map" id="ucommon_1_1keypager_3_01_t_00_01_m_01_4_coll__map">
<area shape="rect" id="node2" href="a00081.html" title="A managed private heap for small allocations." alt="" coords="55,253,247,280"/><area shape="rect" id="node4" href="a00079.html" title="A memory protocol pager for private heap manager." alt="" coords="47,176,239,203"/><area shape="rect" id="node6" href="a00073.html" title="Common locking protocol." alt="" coords="5,91,267,117"/><area shape="rect" id="node8" href="a00090.html" title="A linked object base class with members found by name." alt="" coords="272,253,493,280"/><area shape="rect" id="node10" href="a00101.html" title="A linked object base class for ordered objects." alt="" coords="267,176,509,203"/><area shape="rect" id="node12" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="291,91,523,117"/><area shape="rect" id="node14" href="a00095.html" title="A common base class for all managed objects." alt="" coords="281,5,532,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="a00060.html#a8d84813fbb76f92abb00a2bad050c022">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="#a8d84813fbb76f92abb00a2bad050c022"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a529a9dd6f41d61edf32038acb2ceada3">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="#a529a9dd6f41d61edf32038acb2ceada3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#afa7371d949a7d55978c42dccdcb3b6e6">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="a00090.html" title="A linked object base class with members found by name.">NamedObject</a> in the hash map by name. <a href="#afa7371d949a7d55978c42dccdcb3b6e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ad79e7542482cc1e2bb0f6337918f02ae">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="#ad79e7542482cc1e2bb0f6337918f02ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a7adfca2387b671e51088d2185d0e0cc4">keypager</a> (size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the object cache. <a href="#a7adfca2387b671e51088d2185d0e0cc4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a40e31c53d80b3899537ddc68f5c7891a">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="#a40e31c53d80b3899537ddc68f5c7891a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a220a4206644809ffa4575a6b0fe1d5e7">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="a00090.html" title="A linked object base class with members found by name.">NamedObject</a> in the hash map by name. <a href="#a220a4206644809ffa4575a6b0fe1d5e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a5932254bfb4583a54cbec54e0d6a7bce">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="#a5932254bfb4583a54cbec54e0d6a7bce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a9e8865d0f4cac732d2bb6a544746808e">test</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if a name exists in the pool. <a href="#a9e8865d0f4cac732d2bb6a544746808e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8daddd9988be34e4f3e7a040836b605d"></a><!-- doxytag: member="ucommon::keypager::~keypager" ref="a8daddd9988be34e4f3e7a040836b605d" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a8daddd9988be34e4f3e7a040836b605d">~keypager</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the hash pager by purging the index chains and memory pools. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T, unsigned M = 177><br/>
class ucommon::keypager< T, M ></h3>
<p>A template class for a hash pager. </p>
<p>This creates objects from a pager pool when they do not already exist in the 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="a00190_source.html#l00654">654</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7adfca2387b671e51088d2185d0e0cc4"></a><!-- doxytag: member="ucommon::keypager::keypager" ref="a7adfca2387b671e51088d2185d0e0cc4" args="(size_t size)" -->
<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="a00060.html">ucommon::keypager</a>< T, M >::<a class="el" href="a00060.html">keypager</a> </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create the object cache. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of allocation units. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00664">664</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8d84813fbb76f92abb00a2bad050c022"></a><!-- doxytag: member="ucommon::keypager::begin" ref="a8d84813fbb76f92abb00a2bad050c022" 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="a00060.html">ucommon::keypager</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="a00190_source.html#l00708">708</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
</div>
</div>
<a class="anchor" id="a529a9dd6f41d61edf32038acb2ceada3"></a><!-- doxytag: member="ucommon::keypager::count" ref="a529a9dd6f41d61edf32038acb2ceada3" 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="a00060.html">ucommon::keypager</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="a00190_source.html#l00723">723</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
</div>
</div>
<a class="anchor" id="afa7371d949a7d55978c42dccdcb3b6e6"></a><!-- doxytag: member="ucommon::keypager::get" ref="afa7371d949a7d55978c42dccdcb3b6e6" 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="a00060.html">ucommon::keypager</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="a00090.html" title="A linked object base class with members found by name.">NamedObject</a> in the hash map by name. </p>
<p>If the object is not found, it is created from the memory pool. </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>typed object if found through map or NULL. </dd></dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00678">678</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad79e7542482cc1e2bb0f6337918f02ae"></a><!-- doxytag: member="ucommon::keypager::index" ref="ad79e7542482cc1e2bb0f6337918f02ae" 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="a00060.html">ucommon::keypager</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="a00190_source.html#l00732">732</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
</div>
</div>
<a class="anchor" id="a40e31c53d80b3899537ddc68f5c7891a"></a><!-- doxytag: member="ucommon::keypager::next" ref="a40e31c53d80b3899537ddc68f5c7891a" 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="a00060.html">ucommon::keypager</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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>current</em> </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="a00190_source.html#l00716">716</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
</div>
</div>
<a class="anchor" id="a220a4206644809ffa4575a6b0fe1d5e7"></a><!-- doxytag: member="ucommon::keypager::operator[]" ref="a220a4206644809ffa4575a6b0fe1d5e7" 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="a00060.html">ucommon::keypager</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="a00090.html" title="A linked object base class with members found by name.">NamedObject</a> in the hash map by name. </p>
<p>If the object is not found, it is created from the pager pool. </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>typed object if found through map or NULL. </dd></dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00701">701</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5932254bfb4583a54cbec54e0d6a7bce"></a><!-- doxytag: member="ucommon::keypager::sort" ref="a5932254bfb4583a54cbec54e0d6a7bce" 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="a00060.html">ucommon::keypager</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="a00190_source.html#l00741">741</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9e8865d0f4cac732d2bb6a544746808e"></a><!-- doxytag: member="ucommon::keypager::test" ref="a9e8865d0f4cac732d2bb6a544746808e" 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">bool <a class="el" href="a00060.html">ucommon::keypager</a>< T, M >::test </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>Test if a name exists in the pool. </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 test. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if found. </dd></dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00692">692</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00190_source.html">memory.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>
