<!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::multimap< T, P > 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="a00085.html">multimap</a>
</div>
</div>
<div class="contents">
<h1>ucommon::multimap< T, P > Class Template Reference</h1><!-- doxytag: class="ucommon::multimap" --><!-- doxytag: inherits="ucommon::MultiMap" -->
<p>Embed data objects into a multipap structured memory database.
<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::multimap< T, P >:</div>
<div class="dynsection">
<div class="center"><img src="a00440.png" border="0" usemap="#ucommon_1_1multimap_3_01_t_00_01_p_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1multimap_3_01_t_00_01_p_01_4_inherit__map" id="ucommon_1_1multimap_3_01_t_00_01_p_01_4_inherit__map">
<area shape="rect" id="node2" href="a00084.html" title="A multipath linked list where membership is managed in multiple lists." alt="" coords="45,229,237,256"/><area shape="rect" id="node4" href="a00116.html" title="Reusable objects for forming private heaps." alt="" coords="16,155,267,181"/><area shape="rect" id="node6" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="25,80,257,107"/><area shape="rect" id="node8" href="a00095.html" title="A common base class for all managed objects." alt="" coords="16,5,267,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::multimap< T, P >:</div>
<div class="dynsection">
<div class="center"><img src="a00441.png" border="0" usemap="#ucommon_1_1multimap_3_01_t_00_01_p_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1multimap_3_01_t_00_01_p_01_4_coll__map" id="ucommon_1_1multimap_3_01_t_00_01_p_01_4_coll__map">
<area shape="rect" id="node2" href="a00084.html" title="A multipath linked list where membership is managed in multiple lists." alt="" coords="45,253,237,280"/><area shape="rect" id="node4" href="a00116.html" title="Reusable objects for forming private heaps." alt="" coords="16,176,267,203"/><area shape="rect" id="node6" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="25,91,257,117"/><area shape="rect" id="node8" href="a00095.html" title="A common base class for all managed objects." alt="" coords="16,5,267,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="a00085.html#aec2d971026cb68d8148a0c70dbca9411">get</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the typed value of this node. <a href="#aec2d971026cb68d8148a0c70dbca9411"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a150689a2bb1a4b89271f2b61d120c75a"></a><!-- doxytag: member="ucommon::multimap::multimap" ref="a150689a2bb1a4b89271f2b61d120c75a" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00085.html#a150689a2bb1a4b89271f2b61d120c75a">multimap</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a multimap node. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00085.html">multimap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00085.html#aac99d35b92ab9d0edc47cbb213720c63">next</a> (unsigned path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return next multimap typed object. <a href="#aac99d35b92ab9d0edc47cbb213720c63"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00085.html#a592593bf37ddb57a70712ad44896afd0">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return typed value of this node by pointer reference. <a href="#a592593bf37ddb57a70712ad44896afd0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00085.html#a80e1757188b18c3b4d9177df6f467d0c">operator=</a> (const T &data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign the value of our node. <a href="#a80e1757188b18c3b4d9177df6f467d0c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00085.html#aba5e1fbc6260b899ea43175a8f9e4233">set</a> (const T &reference)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of a data based value tree. <a href="#aba5e1fbc6260b899ea43175a8f9e4233"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00085.html#a79e80e2a3232f7b45a54b99459805c47">setPointer</a> (const T <a class="el" href="a00110.html">pointer</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the pointer of a pointer based value tree. <a href="#a79e80e2a3232f7b45a54b99459805c47"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80ad40e2083b394b8ed4fe429ff624b4"></a><!-- doxytag: member="ucommon::multimap::~multimap" ref="a80ad40e2083b394b8ed4fe429ff624b4" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00085.html#a80ad40e2083b394b8ed4fe429ff624b4">~multimap</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a multimap object. <br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00085.html">multimap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00085.html#abc8fdcc06b49e42c780a347d6791ef3d">find</a> (unsigned path, <a class="el" href="a00084.html">MultiMap</a> **index, caddr_t key, unsigned size, unsigned keysize=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find multimap key entry. <a href="#abc8fdcc06b49e42c780a347d6791ef3d"></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="a14b5ac7cb82155010e1d4441d5a38b8b"></a><!-- doxytag: member="ucommon::multimap::value" ref="a14b5ac7cb82155010e1d4441d5a38b8b" args="" -->
T </td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename T, unsigned P><br/>
class ucommon::multimap< T, P ></h3>
<p>Embed data objects into a multipap structured memory database. </p>
<p>This can be used to form multi-key hash nodes. Embedded values can either be of direct types that are then stored as part of the template object, or of class types that are data pointers. </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#l01448">1448</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abc8fdcc06b49e42c780a347d6791ef3d"></a><!-- doxytag: member="ucommon::multimap::find" ref="abc8fdcc06b49e42c780a347d6791ef3d" args="(unsigned path, MultiMap **index, caddr_t key, unsigned size, unsigned keysize=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , unsigned P> </div>
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00085.html">multimap</a>* <a class="el" href="a00085.html">ucommon::multimap</a>< T, P >::find </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00084.html">MultiMap</a> ** </td>
<td class="paramname"> <em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">caddr_t </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>keysize</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find multimap key entry. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>to search through. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>of associated keys. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>to search for, binary or NULL terminated string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of index used. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keysize</em> </td><td>or 0 if NULL terminated string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>multipath typed object. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01516">1516</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="aec2d971026cb68d8148a0c70dbca9411"></a><!-- doxytag: member="ucommon::multimap::get" ref="aec2d971026cb68d8148a0c70dbca9411" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , unsigned P> </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="a00085.html">ucommon::multimap</a>< T, P >::get </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>Return the typed value of this node. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to value of node. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01468">1468</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="aac99d35b92ab9d0edc47cbb213720c63"></a><!-- doxytag: member="ucommon::multimap::next" ref="aac99d35b92ab9d0edc47cbb213720c63" args="(unsigned path)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , unsigned P> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00085.html">multimap</a>* <a class="el" href="a00085.html">ucommon::multimap</a>< T, P >::next </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return next multimap typed object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>to follow. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>multimap typed. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01476">1476</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a592593bf37ddb57a70712ad44896afd0"></a><!-- doxytag: member="ucommon::multimap::operator*" ref="a592593bf37ddb57a70712ad44896afd0" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , unsigned P> </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="a00085.html">ucommon::multimap</a>< T, P >::operator* </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return typed value of this node by pointer reference. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>value of node. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01483">1483</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a80e1757188b18c3b4d9177df6f467d0c"></a><!-- doxytag: member="ucommon::multimap::operator=" ref="a80e1757188b18c3b4d9177df6f467d0c" args="(const T &data)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , unsigned P> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00085.html">ucommon::multimap</a>< T, P >::operator= </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"> <em>data</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign the value of our node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>value to assign. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01504">1504</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="aba5e1fbc6260b899ea43175a8f9e4233"></a><!-- doxytag: member="ucommon::multimap::set" ref="aba5e1fbc6260b899ea43175a8f9e4233" args="(const T &reference)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , unsigned P> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00085.html">ucommon::multimap</a>< T, P >::set </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"> <em>reference</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the value of a data based value tree. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>reference</em> </td><td>to value to copy into node. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01497">1497</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a79e80e2a3232f7b45a54b99459805c47"></a><!-- doxytag: member="ucommon::multimap::setPointer" ref="a79e80e2a3232f7b45a54b99459805c47" args="(const T pointer)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , unsigned P> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00085.html">ucommon::multimap</a>< T, P >::setPointer </td>
<td>(</td>
<td class="paramtype">const T </td>
<td class="paramname"> <em>pointer</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the pointer of a pointer based value tree. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pointer</em> </td><td>to set. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01490">1490</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="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:45 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>
