/usr/share/doc/ucommon-doc/html/a00606.html is in ucommon-doc 7.0.0-9.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 | <!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UCommon: ucommon::linked_value< T, O > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">UCommon
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00563.html">ucommon</a></li><li class="navelem"><a class="el" href="a00606.html">linked_value</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">ucommon::linked_value< T, O > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A linked object base class for ordered objects.
<a href="a00606.html#details">More...</a></p>
<p><code>#include <<a class="el" href="a00449_source.html">linked.h</a>></code></p>
<p>Inherits O.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa9da502a8cd2b590259a84352708a680"><td class="memItemLeft" align="right" valign="top"><a id="aa9da502a8cd2b590259a84352708a680"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00606.html#aa9da502a8cd2b590259a84352708a680">linked_value</a> ()</td></tr>
<tr class="memdesc:aa9da502a8cd2b590259a84352708a680"><td class="mdescLeft"> </td><td class="mdescRight">Create embedded value object unlinked. <br /></td></tr>
<tr class="separator:aa9da502a8cd2b590259a84352708a680"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4eef4a94352e7ee35921ee1bbc9ff4cd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00606.html#a4eef4a94352e7ee35921ee1bbc9ff4cd">linked_value</a> (LinkedObject **root)</td></tr>
<tr class="memdesc:a4eef4a94352e7ee35921ee1bbc9ff4cd"><td class="mdescLeft"> </td><td class="mdescRight">Construct embedded object on a linked list. <a href="#a4eef4a94352e7ee35921ee1bbc9ff4cd">More...</a><br /></td></tr>
<tr class="separator:a4eef4a94352e7ee35921ee1bbc9ff4cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05868a999cce23fe5fdb5baac9556d50"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00606.html#a05868a999cce23fe5fdb5baac9556d50">linked_value</a> (OrderedIndex *index)</td></tr>
<tr class="memdesc:a05868a999cce23fe5fdb5baac9556d50"><td class="mdescLeft"> </td><td class="mdescRight">Construct embedded object on an ordered list. <a href="#a05868a999cce23fe5fdb5baac9556d50">More...</a><br /></td></tr>
<tr class="separator:a05868a999cce23fe5fdb5baac9556d50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29712e1e6122de679358472b544de2d3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00606.html#a29712e1e6122de679358472b544de2d3">linked_value</a> (LinkedObject **root, const T &typed_value)</td></tr>
<tr class="memdesc:a29712e1e6122de679358472b544de2d3"><td class="mdescLeft"> </td><td class="mdescRight">Assign embedded value from related type and link to list. <a href="#a29712e1e6122de679358472b544de2d3">More...</a><br /></td></tr>
<tr class="separator:a29712e1e6122de679358472b544de2d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58444e1a43d8d1c9be898c26d362582b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00606.html#a58444e1a43d8d1c9be898c26d362582b">linked_value</a> (OrderedIndex *index, const T &typed_value)</td></tr>
<tr class="memdesc:a58444e1a43d8d1c9be898c26d362582b"><td class="mdescLeft"> </td><td class="mdescRight">Assign embedded value from related type and add to list. <a href="#a58444e1a43d8d1c9be898c26d362582b">More...</a><br /></td></tr>
<tr class="separator:a58444e1a43d8d1c9be898c26d362582b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5be5eb4b0075d8e153590014e8326cf6"><td class="memItemLeft" align="right" valign="top"><a id="a5be5eb4b0075d8e153590014e8326cf6"></a>
 </td><td class="memItemRight" valign="bottom"><b>operator T &</b> ()</td></tr>
<tr class="separator:a5be5eb4b0075d8e153590014e8326cf6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11fdd0961467c30d5825a7a31b3bb257"><td class="memItemLeft" align="right" valign="top"><a id="a11fdd0961467c30d5825a7a31b3bb257"></a>
void </td><td class="memItemRight" valign="bottom"><b>operator()</b> (const T data)</td></tr>
<tr class="separator:a11fdd0961467c30d5825a7a31b3bb257"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8aa9df6cdb2430de1ea7dd29e0bda52"><td class="memItemLeft" align="right" valign="top"><a id="aa8aa9df6cdb2430de1ea7dd29e0bda52"></a>
T & </td><td class="memItemRight" valign="bottom"><b>operator*</b> ()</td></tr>
<tr class="separator:aa8aa9df6cdb2430de1ea7dd29e0bda52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1bbcac48de7522d4aea5b82ada3a8cab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00606.html">linked_value</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00606.html#a1bbcac48de7522d4aea5b82ada3a8cab">operator=</a> (const T &typed_value)</td></tr>
<tr class="memdesc:a1bbcac48de7522d4aea5b82ada3a8cab"><td class="mdescLeft"> </td><td class="mdescRight">Assign embedded value from related type. <a href="#a1bbcac48de7522d4aea5b82ada3a8cab">More...</a><br /></td></tr>
<tr class="separator:a1bbcac48de7522d4aea5b82ada3a8cab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44a8b1b81d6596251da98a65d5f79f62"><td class="memItemLeft" align="right" valign="top"><a id="a44a8b1b81d6596251da98a65d5f79f62"></a>
void </td><td class="memItemRight" valign="bottom"><b>set</b> (const T &typed_value)</td></tr>
<tr class="separator:a44a8b1b81d6596251da98a65d5f79f62"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a92c95dfc0585c3386ad98c67cf5801fa"><td class="memItemLeft" align="right" valign="top"><a id="a92c95dfc0585c3386ad98c67cf5801fa"></a>
T </td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
<tr class="separator:a92c95dfc0585c3386ad98c67cf5801fa"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aeb1fd139a9cb52bcfad77832de7c2d89"><td class="memItemLeft" align="right" valign="top"><a id="aeb1fd139a9cb52bcfad77832de7c2d89"></a>
 </td><td class="memItemRight" valign="bottom"><b>linked_value</b> (const <a class="el" href="a00606.html">linked_value</a> &)</td></tr>
<tr class="separator:aeb1fd139a9cb52bcfad77832de7c2d89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22c932e3505043bccc1231dc4f61a84b"><td class="memItemLeft" align="right" valign="top"><a id="a22c932e3505043bccc1231dc4f61a84b"></a>
<a class="el" href="a00606.html">linked_value</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="a00606.html">linked_value</a> &)</td></tr>
<tr class="separator:a22c932e3505043bccc1231dc4f61a84b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename T, class O = LinkedObject><br />
class ucommon::linked_value< T, O ></h3>
<p>A linked object base class for ordered objects. </p>
<p>This is used for objects that must be ordered and listed through the OrderedIndex class. </p><dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> A linked object base class with members found by name. This class is used to help form named option lists and other forms of name indexed associative data structures. The id is assumed to be passed from a dupped or dynamically allocated string. If a constant string is used then you must not call delete for this object.</dd></dl>
<p>Named objects are either listed on an ordered list or keyed through an associate hash map table. When using a hash table, the name id string is used to determine the slot number to use in a list of n sized linked object lists. Hence, a hash index refers to a specific sized array of object indexes. </p><dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> The named tree class is used to form a tree oriented list of associated objects. Typical uses for such data structures might be to form a parsed XML document, or for forming complex configuration management systems or for forming system resource management trees. </dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> A double linked list object. This is used as a base class for objects that will be organized through ordered double linked lists which allow convenient insertion and deletion of list members anywhere in the list. </dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> Template value class to embed data structure into a linked list. This is used to form a class which can be linked together using either an ordered index or simple linked pointer chain and that contains a member value object. Most of the core logic for this template is found in and derived from the object_value template. </dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="a00765.html#_a0">linked.cpp</a>.</dd>
</dl>
<p>Definition at line <a class="el" href="a00449_source.html#l00909">909</a> of file <a class="el" href="a00449_source.html">linked.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a4eef4a94352e7ee35921ee1bbc9ff4cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4eef4a94352e7ee35921ee1bbc9ff4cd">§ </a></span>linked_value() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , class O = LinkedObject> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00606.html">ucommon::linked_value</a>< T, O >::<a class="el" href="a00606.html">linked_value</a> </td>
<td>(</td>
<td class="paramtype">LinkedObject ** </td>
<td class="paramname"><em>root</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct embedded object on a linked list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">root</td><td>node or pointer for list. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00449_source.html#l00926">926</a> of file <a class="el" href="a00449_source.html">linked.h</a>.</p>
</div>
</div>
<a id="a05868a999cce23fe5fdb5baac9556d50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05868a999cce23fe5fdb5baac9556d50">§ </a></span>linked_value() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , class O = LinkedObject> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00606.html">ucommon::linked_value</a>< T, O >::<a class="el" href="a00606.html">linked_value</a> </td>
<td>(</td>
<td class="paramtype">OrderedIndex * </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct embedded object on an ordered list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>pointer for the ordered list. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00449_source.html#l00934">934</a> of file <a class="el" href="a00449_source.html">linked.h</a>.</p>
</div>
</div>
<a id="a29712e1e6122de679358472b544de2d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29712e1e6122de679358472b544de2d3">§ </a></span>linked_value() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , class O = LinkedObject> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00606.html">ucommon::linked_value</a>< T, O >::<a class="el" href="a00606.html">linked_value</a> </td>
<td>(</td>
<td class="paramtype">LinkedObject ** </td>
<td class="paramname"><em>root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>typed_value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assign embedded value from related type and link to list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">root</td><td>node or pointer for list. </td></tr>
<tr><td class="paramname">typed_value</td><td>to assign. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00449_source.html#l00943">943</a> of file <a class="el" href="a00449_source.html">linked.h</a>.</p>
</div>
</div>
<a id="a58444e1a43d8d1c9be898c26d362582b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58444e1a43d8d1c9be898c26d362582b">§ </a></span>linked_value() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , class O = LinkedObject> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00606.html">ucommon::linked_value</a>< T, O >::<a class="el" href="a00606.html">linked_value</a> </td>
<td>(</td>
<td class="paramtype">OrderedIndex * </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>typed_value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assign embedded value from related type and add to list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>to list our object on. </td></tr>
<tr><td class="paramname">typed_value</td><td>to assign. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00449_source.html#l00953">953</a> of file <a class="el" href="a00449_source.html">linked.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1bbcac48de7522d4aea5b82ada3a8cab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bbcac48de7522d4aea5b82ada3a8cab">§ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , class O = LinkedObject> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00606.html">linked_value</a>& <a class="el" href="a00606.html">ucommon::linked_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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assign embedded value from related type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">typed_value</td><td>to assign. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00449_source.html#l00966">966</a> of file <a class="el" href="a00449_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="a00449_source.html">linked.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
|