<!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: named_value< T, O > 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('a00087.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>named_value< T, O > Class Template Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="named_value" --><!-- doxytag: inherits="object_value" -->
<p>Template value class to embed data structure into a named list.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00187_source.html">linked.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for named_value< T, O >:</div>
<div class="dyncontent">
<div class="center"><img src="a00382.png" border="0" usemap="#named__value_3_01_t_00_01_o_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="named__value_3_01_t_00_01_o_01_4_inherit__map" id="named__value_3_01_t_00_01_o_01_4_inherit__map">
<area shape="rect" id="node2" href="a00093.html" title="Template for embedding a data structure into a reference counted object." alt="" coords="5,5,227,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for named_value< T, O >:</div>
<div class="dyncontent">
<div class="center"><img src="a00383.png" border="0" usemap="#named__value_3_01_t_00_01_o_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="named__value_3_01_t_00_01_o_01_4_coll__map" id="named__value_3_01_t_00_01_o_01_4_coll__map">
<area shape="rect" id="node2" href="a00093.html" title="Template for embedding a data structure into a reference counted object." alt="" coords="5,5,227,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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00087.html#aa7b68848ac844ad66f53021a99640a1b">named_value</a> (<a class="el" href="a00065.html">LinkedObject</a> **root, char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct embedded named object on a linked list. <a href="#aa7b68848ac844ad66f53021a99640a1b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00087.html#ad789a1b9d6005f2d416c3970a0e2e12a">operator=</a> (const T &typed_value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign embedded value from related type. <a href="#ad789a1b9d6005f2d416c3970a0e2e12a"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00087.html">named_value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00087.html#a638c01b8ad61ef5d85179ae3903a0ef4">find</a> (<a class="el" href="a00087.html">named_value</a> *first, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find embedded object in chain by name. <a href="#a638c01b8ad61ef5d85179ae3903a0ef4"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<typename T, class O = NamedObject><br/>
class named_value< T, O ></h3>
<p>Template value class to embed data structure into a named list. </p>
<p>This is used to form a class which can be searched by name and that contains a member value object. Most of the core logic for this template is found in and derived from the <a class="el" href="a00093.html" title="Template for embedding a data structure into a reference counted object.">object_value</a> template. </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#l01043">1043</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa7b68848ac844ad66f53021a99640a1b"></a><!-- doxytag: member="named_value::named_value" ref="aa7b68848ac844ad66f53021a99640a1b" args="(LinkedObject **root, char *name)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , class O = NamedObject> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00087.html">named_value</a>< T, O >::<a class="el" href="a00087.html">named_value</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00065.html">LinkedObject</a> ** </td>
<td class="paramname"><em>root</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></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct embedded named object on a linked list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">root</td><td>node or pointer for list. </td></tr>
<tr><td class="paramname">name</td><td>of our object. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01051">1051</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="a00087_aa7b68848ac844ad66f53021a99640a1b_cgraph.png" border="0" usemap="#a00087_aa7b68848ac844ad66f53021a99640a1b_cgraph" alt=""/></div>
<map name="a00087_aa7b68848ac844ad66f53021a99640a1b_cgraph" id="a00087_aa7b68848ac844ad66f53021a99640a1b_cgraph">
<area shape="rect" id="node3" href="a00065.html#a955450e35b5f1ec3d7428b05d629bc49" title="Add our object to an existing linked list through a pointer." alt="" coords="319,5,540,32"/></map>
</div>
</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a638c01b8ad61ef5d85179ae3903a0ef4"></a><!-- doxytag: member="named_value::find" ref="a638c01b8ad61ef5d85179ae3903a0ef4" args="(named_value *first, const char *name)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , class O = NamedObject> </div>
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00087.html">named_value</a> <a class="el" href="a00087.html">named_value</a>< T, O >::find </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00087.html">named_value</a>< T, O > * </td>
<td class="paramname"><em>first</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></td>
<td>)</td>
<td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find embedded object in chain by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">first</td><td>object in list to search from. </td></tr>
<tr><td class="paramname">name</td><td>to search for. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>composite object found by name or NULL if not found. </dd></dl>
<p>Definition at line <a class="el" href="a00187_source.html#l01067">1067</a> of file <a class="el" href="a00187_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad789a1b9d6005f2d416c3970a0e2e12a"></a><!-- doxytag: member="named_value::operator=" ref="ad789a1b9d6005f2d416c3970a0e2e12a" args="(const T &typed_value)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , class O = NamedObject> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00087.html">named_value</a>< T, O >::operator= </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>typed_value</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign embedded value from related type. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">typed_value</td><td>to assign. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="a00093.html#a6d698ee094c284433cd1fef081ca7851">object_value< T, O ></a>.</p>
<p>Definition at line <a class="el" href="a00187_source.html#l01058">1058</a> of file <a class="el" href="a00187_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="a00187_source.html">linked.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00087.html">named_value</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:48 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>
