<!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>GNU CommonC++: ost::objMap< T, K, S > 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="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>Classes</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>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1obj_map.html">objMap</a> </div> </div> <div class="contents"> <h1>ost::objMap< T, K, S > Class Template Reference</h1><!-- doxytag: class="ost::objMap" --> <p>Used to create and manage a hash index of objects through a common type. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="objmap_8h_source.html">objmap.h</a>></code></p> <p><a href="classost_1_1obj_map-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1obj_map.html#a6a4a422b97bf84670c05c934d93371ea">getObject</a> (keystring key)</td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1obj_map.html#a569d900c4fd6288742df69b5f9892e64">keyIndex</a> (K k)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1obj_map.html#afc0f9891beba8ddfd2285566c74f1a62">getSize</a> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1obj_map.html#a8a7026786efd9c660fbdfa05205ea313">objMap</a> (const K key)</td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1obj_map.html#a1fc9048257b5dd2cf98fe1d86ee8d75b">objNext</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const K </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1obj_map.html#a96897e628e96ca4590efb4c84db7edf0">objKey</a></td></tr> <tr><td colspan="2"><h2>Static Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1obj_map.html#aef8176a8acd51c60d305df1dc33c667d">objIndex</a> [S]</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <h3>template<class T, class K, unsigned S><br/> class ost::objMap< T, K, S ></h3> <p>Used to create and manage a hash index of objects through a common type. </p> <p>The objects can be examined and a specific instance located by a hash key.</p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> hash indexed searchable template chain. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a8a7026786efd9c660fbdfa05205ea313"></a><!-- doxytag: member="ost::objMap::objMap" ref="a8a7026786efd9c660fbdfa05205ea313" args="(const K key)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T, class K, unsigned S> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1obj_map.html">ost::objMap</a>< T, K, S >::<a class="el" href="classost_1_1obj_map.html">objMap</a> </td> <td>(</td> <td class="paramtype">const K </td> <td class="paramname"> <em>key</em></td> <td> ) </td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a6a4a422b97bf84670c05c934d93371ea"></a><!-- doxytag: member="ost::objMap::getObject" ref="a6a4a422b97bf84670c05c934d93371ea" args="(keystring key)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T , class K , unsigned S> </div> <table class="memname"> <tr> <td class="memname">T * <a class="el" href="classost_1_1obj_map.html">ost::objMap</a>< T, K, S >::getObject </td> <td>(</td> <td class="paramtype">keystring </td> <td class="paramname"> <em>key</em></td> <td> ) </td> <td><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="objmap_8h_source.html#l00066">ost::objMap< T, K, S >::keyIndex()</a>, and <a class="el" href="objmap_8h_source.html#l00062">ost::objMap< T, K, S >::objIndex</a>.</p> </div> </div> <a class="anchor" id="afc0f9891beba8ddfd2285566c74f1a62"></a><!-- doxytag: member="ost::objMap::getSize" ref="afc0f9891beba8ddfd2285566c74f1a62" args="(void)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T, class K, unsigned S> </div> <table class="memname"> <tr> <td class="memname">unsigned <a class="el" href="classost_1_1obj_map.html">ost::objMap</a>< T, K, S >::getSize </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a569d900c4fd6288742df69b5f9892e64"></a><!-- doxytag: member="ost::objMap::keyIndex" ref="a569d900c4fd6288742df69b5f9892e64" args="(K k)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T, class K, unsigned S> </div> <table class="memname"> <tr> <td class="memname">virtual unsigned <a class="el" href="classost_1_1obj_map.html">ost::objMap</a>< T, K, S >::keyIndex </td> <td>(</td> <td class="paramtype">K </td> <td class="paramname"> <em>k</em></td> <td> ) </td> <td><code> [inline, protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="objmap_8h_source.html#l00113">ost::objMap< T, K, S >::getObject()</a>, and <a class="el" href="objmap_8h_source.html#l00082">ost::objMap< T, keystring, S >::objMap()</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="aef8176a8acd51c60d305df1dc33c667d"></a><!-- doxytag: member="ost::objMap::objIndex" ref="aef8176a8acd51c60d305df1dc33c667d" args="[S]" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T, class K, unsigned S> </div> <table class="memname"> <tr> <td class="memname">T * <a class="el" href="classost_1_1obj_map.html">ost::objMap</a>< T, K, S >::<a class="el" href="classost_1_1obj_map.html#aef8176a8acd51c60d305df1dc33c667d">objIndex</a> </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, static, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="objmap_8h_source.html#l00113">ost::objMap< T, K, S >::getObject()</a>, and <a class="el" href="objmap_8h_source.html#l00082">ost::objMap< T, keystring, S >::objMap()</a>.</p> </div> </div> <a class="anchor" id="a96897e628e96ca4590efb4c84db7edf0"></a><!-- doxytag: member="ost::objMap::objKey" ref="a96897e628e96ca4590efb4c84db7edf0" args="" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T, class K, unsigned S> </div> <table class="memname"> <tr> <td class="memname">const K <a class="el" href="classost_1_1obj_map.html">ost::objMap</a>< T, K, S >::<a class="el" href="classost_1_1obj_map.html#a96897e628e96ca4590efb4c84db7edf0">objKey</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="objmap_8h_source.html#l00082">ost::objMap< T, keystring, S >::objMap()</a>.</p> </div> </div> <a class="anchor" id="a1fc9048257b5dd2cf98fe1d86ee8d75b"></a><!-- doxytag: member="ost::objMap::objNext" ref="a1fc9048257b5dd2cf98fe1d86ee8d75b" args="" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T, class K, unsigned S> </div> <table class="memname"> <tr> <td class="memname">T* <a class="el" href="classost_1_1obj_map.html">ost::objMap</a>< T, K, S >::<a class="el" href="classost_1_1obj_map.html#a1fc9048257b5dd2cf98fe1d86ee8d75b">objNext</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="objmap_8h_source.html#l00082">ost::objMap< T, keystring, S >::objMap()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="objmap_8h_source.html">objmap.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ 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>