/usr/share/doc/libelemental-doc/api/classElemental_1_1value__base.html is in libelemental-doc 1.2.0-7ubuntu1.
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 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 | <!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>libelemental: Elemental::value_base Class 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.7.4 -->
<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">libelemental <span id="projectnumber">1.2.0</span></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="modules.html"><span>Modules</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceElemental.html">Elemental</a> </li>
<li class="navelem"><a class="el" href="classElemental_1_1value__base.html">value_base</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">Elemental::value_base Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Elemental::value_base" -->
<p>A base class for qualified values.
<a href="classElemental_1_1value__base.html#details">More...</a></p>
<p><code>#include <value.hh></code></p>
<div class="dynheader">
Inheritance diagram for Elemental::value_base:</div>
<div class="dyncontent">
<div class="center"><img src="classElemental_1_1value__base__inherit__graph.png" border="0" usemap="#Elemental_1_1value__base_inherit__map" alt="Inheritance graph"/></div>
<map name="Elemental_1_1value__base_inherit__map" id="Elemental_1_1value__base_inherit__map">
<area shape="rect" id="node3" href="classElemental_1_1color__value__base.html" title="A base class for qualified values which have representative colors." alt="" coords="225,106,428,134"/><area shape="rect" id="node15" href="classElemental_1_1Event.html" title="A qualified value representing the time and location of an event." alt="" coords="261,157,392,185"/><area shape="rect" id="node17" href="classElemental_1_1Message.html" title="A qualified UTF-8 string value that requires translation." alt="" coords="252,207,401,235"/><area shape="rect" id="node19" href="classElemental_1_1Value.html" title="A qualified value of a generic type." alt="" coords="244,309,409,337"/><area shape="rect" id="node21" href="classElemental_1_1Value.html" title="Elemental::Value\< double \>" alt="" coords="552,353,755,381"/><area shape="rect" id="node23" href="classElemental_1_1Value.html" title="Elemental::Value\< ustring \>" alt="" coords="552,282,755,310"/><area shape="rect" id="node25" href="classElemental_1_1ValueList.html" title="A qualified list of values of a generic type." alt="" coords="233,435,420,463"/><area shape="rect" id="node5" href="classElemental_1_1Block.html" title="A qualified value representing a periodic table block." alt="" coords="589,207,717,235"/><area shape="rect" id="node7" href="classElemental_1_1ColorValue.html" title="A qualified value representing a display color." alt="" coords="572,5,735,33"/><area shape="rect" id="node9" href="classElemental_1_1LatticeType.html" title="A qualified value representing a Bravais lattice type." alt="" coords="571,55,736,83"/><area shape="rect" id="node11" href="classElemental_1_1Phase.html" title="A qualified value representing a phase of matter." alt="" coords="587,106,720,134"/><area shape="rect" id="node13" href="classElemental_1_1Series.html" title="A qualified value representing a chemical series." alt="" coords="587,157,720,185"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classElemental_1_1value__base-members.html">List of all members.</a></p>
<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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#a9b73271fa88c4861827c915807acec54">has_value</a> () const throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the value is defined. <a href="#a9b73271fa88c4861827c915807acec54"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#a996d6754d304ef59c85d407318e661ba">get_string</a> (const ustring &format=ustring()) const throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a localized text representation of the value. <a href="#a996d6754d304ef59c85d407318e661ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#a91108d9a995f20d8121f015c0042c496">get_tip</a> () const throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a localized message to be displayed as a tooltip. <a href="#a91108d9a995f20d8121f015c0042c496"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#a06397c57d933ac7abd0a7da321408cfa">make_entry</a> (<a class="el" href="classElemental_1_1EntriesView.html">EntriesView</a> &view, const ustring &name, const ustring &format=ustring()) const throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Possibly adds the result of <a class="el" href="classElemental_1_1value__base.html#a996d6754d304ef59c85d407318e661ba" title="Returns a localized text representation of the value.">get_string()</a> to an <a class="el" href="classElemental_1_1EntriesView.html" title="An interface for the display of value entries.">EntriesView</a>. <a href="#a06397c57d933ac7abd0a7da321408cfa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#a6607fbcd840b927aedfedacc75326946">compare</a> (const <a class="el" href="classElemental_1_1value__base.html">value_base</a> &other) const throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compares two qualified values. <a href="#a6607fbcd840b927aedfedacc75326946"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6a9585eaec7dfc245e7c7b98bb5698a"></a><!-- doxytag: member="Elemental::value_base::qualifier" ref="aa6a9585eaec7dfc245e7c7b98bb5698a" args="" -->
<a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2">Qualifier</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#aa6a9585eaec7dfc245e7c7b98bb5698a">qualifier</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The qualification of the value's meaning. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#ad6971ae9ef170930c43eb6bc8336d1b9">value_base</a> (<a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2">Qualifier</a> <a class="el" href="classElemental_1_1value__base.html#aa6a9585eaec7dfc245e7c7b98bb5698a">qualifier</a>) throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#a9f0e1f72aee2897d2116037b00cf6cca">do_get_string</a> (const ustring &format) const =0 throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a localized text representation of a defined value. <a href="#a9f0e1f72aee2897d2116037b00cf6cca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#aa05e87556fe6804830d671601698a93f">compare_base</a> (const <a class="el" href="classElemental_1_1value__base.html">value_base</a> &other) const throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compares the qualifications of two values. <a href="#aa05e87556fe6804830d671601698a93f"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#a9384ecc1c5343d77b78de138d0608856">always</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether an undefined value should make an entry. <a href="#a9384ecc1c5343d77b78de138d0608856"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#ad9bea11e6cb5dc088d028a025e03dd32">YIELD_COMPARE</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates that comparison should be based on values, not definedness. <a href="#ad9bea11e6cb5dc088d028a025e03dd32"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A base class for qualified values. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad6971ae9ef170930c43eb6bc8336d1b9"></a><!-- doxytag: member="Elemental::value_base::value_base" ref="ad6971ae9ef170930c43eb6bc8336d1b9" args="(Qualifier qualifier)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Elemental::value_base::value_base </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2">Qualifier</a> </td>
<td class="paramname"><em>qualifier</em></td><td>)</td>
<td> throw ()<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">qualifier</td><td>The qualification of the initial value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6607fbcd840b927aedfedacc75326946"></a><!-- doxytag: member="Elemental::value_base::compare" ref="a6607fbcd840b927aedfedacc75326946" args="(const value_base &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Elemental::value_base::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classElemental_1_1value__base.html">value_base</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const throw ()<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compares two qualified values. </p>
<p>Derived classes may override this function, first calling compare_base, and use a dynamic_cast to check other. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The qualified value for comparison. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>-1</code> if this value is undefined or is less than <code>other</code>; <code>0</code> if the values are equal; or <code>1</code> if <code>other</code> is undefined or this value is greater than <code>other</code>. </dd></dl>
<p>Reimplemented in <a class="el" href="classElemental_1_1Value.html#a1bd8071fd7577cdae7a594da79eb312d">Elemental::Value< T ></a>, <a class="el" href="classElemental_1_1ValueList.html#ab9250b04ee2ae83d90e29a9747714581">Elemental::ValueList< T ></a>, <a class="el" href="classElemental_1_1Message.html#ae974d08814e9de19dcb48a82d9b30124">Elemental::Message</a>, <a class="el" href="classElemental_1_1Event.html#ac5c7c8265d660c1e63c33d98c1771bf1">Elemental::Event</a>, <a class="el" href="classElemental_1_1Series.html#ae3370f81809db79780c004c056c4c3c6">Elemental::Series</a>, <a class="el" href="classElemental_1_1Block.html#a43e4dfbbfa72fa5798de7b458a8439ea">Elemental::Block</a>, <a class="el" href="classElemental_1_1Phase.html#a81c313cf9510e502f84061e1ccec2577">Elemental::Phase</a>, <a class="el" href="classElemental_1_1LatticeType.html#ac675b008b5ce1eebb8525acb2a42af2b">Elemental::LatticeType</a>, <a class="el" href="classElemental_1_1ColorValue.html#afd09e4c2cf59c93bb0e8867f9b443955">Elemental::ColorValue</a>, <a class="el" href="classElemental_1_1Value.html#a1bd8071fd7577cdae7a594da79eb312d">Elemental::Value< double ></a>, and <a class="el" href="classElemental_1_1Value.html#a1bd8071fd7577cdae7a594da79eb312d">Elemental::Value< ustring ></a>.</p>
</div>
</div>
<a class="anchor" id="aa05e87556fe6804830d671601698a93f"></a><!-- doxytag: member="Elemental::value_base::compare_base" ref="aa05e87556fe6804830d671601698a93f" args="(const value_base &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Elemental::value_base::compare_base </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classElemental_1_1value__base.html">value_base</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const throw ()<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compares the qualifications of two values. </p>
<p>This base function handles definedness only. Derived classes may override this function to handle qualifiers more specifically. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The qualified value for comparison. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>-1</code> if this value sorts before <code>other</code>; <code>0</code> if the values sort equally; <code>1</code> if this value sorts after <code>other</code>; or <code>YIELD_COMPARE</code> if the result should be determined based on values. </dd></dl>
<p>Reimplemented in <a class="el" href="classElemental_1_1Event.html#acf5b007b4acc9d7993c6a497ae8a0327">Elemental::Event</a>.</p>
</div>
</div>
<a class="anchor" id="a9f0e1f72aee2897d2116037b00cf6cca"></a><!-- doxytag: member="Elemental::value_base::do_get_string" ref="a9f0e1f72aee2897d2116037b00cf6cca" args="(const ustring &format) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ustring Elemental::value_base::do_get_string </td>
<td>(</td>
<td class="paramtype">const ustring & </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td> const throw ()<code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a localized text representation of a defined value. </p>
<p>Derived classes must implement this function to produce a text representation based on the format. It will be called by <a class="el" href="classElemental_1_1value__base.html#a996d6754d304ef59c85d407318e661ba" title="Returns a localized text representation of the value.">get_string()</a>, which will then decorate its output as appropriate for the current qualifier. If <a class="el" href="classElemental_1_1value__base.html#a9b73271fa88c4861827c915807acec54" title="Returns whether the value is defined.">has_value()</a> is <code>false</code>, the behavior is undefined. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>A compose-style format string. Derived classes may define the number of argument references expected in the string; the default is one. If <code>format</code> is empty, a minimal default should be used. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A UTF-8 string containing the localized representation. </dd></dl>
<p>Implemented in <a class="el" href="classElemental_1_1Value.html#a2aacc75f2c65961195d903f65a641e65">Elemental::Value< T ></a>, <a class="el" href="classElemental_1_1ValueList.html#a50ba3d383396e7fa1e5e7268066b9f22">Elemental::ValueList< T ></a>, <a class="el" href="classElemental_1_1Message.html#a93a0beba517ffc716bbd529f4300f139">Elemental::Message</a>, <a class="el" href="classElemental_1_1Event.html#afe4113dfaf4e9072d33eb5ffa6066168">Elemental::Event</a>, <a class="el" href="classElemental_1_1Series.html#ab059a59107aff85868c5513a056982b1">Elemental::Series</a>, <a class="el" href="classElemental_1_1Block.html#a64d8a6d473883478b7873e8bea695d73">Elemental::Block</a>, <a class="el" href="classElemental_1_1Phase.html#a972b0d4146b97b903fa2cac5c87ee0ce">Elemental::Phase</a>, <a class="el" href="classElemental_1_1LatticeType.html#ac3755f3fc03e429dbff6f744293884ab">Elemental::LatticeType</a>, <a class="el" href="classElemental_1_1ColorValue.html#a6237c9c11d6f7a1938a6d316c9954377">Elemental::ColorValue</a>, <a class="el" href="classElemental_1_1Value.html#a2aacc75f2c65961195d903f65a641e65">Elemental::Value< double ></a>, and <a class="el" href="classElemental_1_1Value.html#a2aacc75f2c65961195d903f65a641e65">Elemental::Value< ustring ></a>.</p>
</div>
</div>
<a class="anchor" id="a996d6754d304ef59c85d407318e661ba"></a><!-- doxytag: member="Elemental::value_base::get_string" ref="a996d6754d304ef59c85d407318e661ba" args="(const ustring &format=ustring()) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ustring Elemental::value_base::get_string </td>
<td>(</td>
<td class="paramtype">const ustring & </td>
<td class="paramname"><em>format</em> = <code>ustring()</code></td><td>)</td>
<td> const throw ()<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a localized text representation of the value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>An optional compose-style format string with which to output the value. If not otherwise specified, the value is argument reference <code>%%1</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A UTF-8 string containing the localized representation. </dd></dl>
<p>Reimplemented in <a class="el" href="classElemental_1_1Message.html#ab68cd54cae801e9d6614857d5ca77aff">Elemental::Message</a>, and <a class="el" href="classElemental_1_1Event.html#a864a1854f3432553820ec9903545c786">Elemental::Event</a>.</p>
</div>
</div>
<a class="anchor" id="a91108d9a995f20d8121f015c0042c496"></a><!-- doxytag: member="Elemental::value_base::get_tip" ref="a91108d9a995f20d8121f015c0042c496" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ustring Elemental::value_base::get_tip </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const throw ()</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a localized message to be displayed as a tooltip. </p>
<p>The message may also be displayed parenthetically to the value. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A UTF-8 string containing the tip text, if any. </dd></dl>
</div>
</div>
<a class="anchor" id="a9b73271fa88c4861827c915807acec54"></a><!-- doxytag: member="Elemental::value_base::has_value" ref="a9b73271fa88c4861827c915807acec54" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Elemental::value_base::has_value </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const throw ()</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the value is defined. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>false</code> if the value is unknown or inapplicable; else <code>true</code> </dd></dl>
</div>
</div>
<a class="anchor" id="a06397c57d933ac7abd0a7da321408cfa"></a><!-- doxytag: member="Elemental::value_base::make_entry" ref="a06397c57d933ac7abd0a7da321408cfa" args="(EntriesView &view, const ustring &name, const ustring &format=ustring()) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Elemental::value_base::make_entry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classElemental_1_1EntriesView.html">EntriesView</a> & </td>
<td class="paramname"><em>view</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ustring & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ustring & </td>
<td class="paramname"><em>format</em> = <code>ustring()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const throw ()</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Possibly adds the result of <a class="el" href="classElemental_1_1value__base.html#a996d6754d304ef59c85d407318e661ba" title="Returns a localized text representation of the value.">get_string()</a> to an <a class="el" href="classElemental_1_1EntriesView.html" title="An interface for the display of value entries.">EntriesView</a>. </p>
<p>An entry will only be made if the value is defined or if <code>always</code> is <code>true</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">view</td><td>The <a class="el" href="classElemental_1_1EntriesView.html" title="An interface for the display of value entries.">EntriesView</a> to be populated. </td></tr>
<tr><td class="paramname">name</td><td>The name of the value to be passed. </td></tr>
<tr><td class="paramname">format</td><td>An optional compose-style format for <a class="el" href="classElemental_1_1value__base.html#a996d6754d304ef59c85d407318e661ba" title="Returns a localized text representation of the value.">get_string()</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a9384ecc1c5343d77b78de138d0608856"></a><!-- doxytag: member="Elemental::value_base::always" ref="a9384ecc1c5343d77b78de138d0608856" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classElemental_1_1value__base.html#a9384ecc1c5343d77b78de138d0608856">Elemental::value_base::always</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Whether an undefined value should make an entry. </p>
<p>May be set by derived classes. If set to <code>false</code> (default), <a class="el" href="classElemental_1_1value__base.html#a06397c57d933ac7abd0a7da321408cfa" title="Possibly adds the result of get_string() to an EntriesView.">make_entry()</a> will only populate an <a class="el" href="classElemental_1_1EntriesView.html" title="An interface for the display of value entries.">EntriesView</a> if <a class="el" href="classElemental_1_1value__base.html#a9b73271fa88c4861827c915807acec54" title="Returns whether the value is defined.">has_value()</a> returns <code>true</code>. If set to <code>true</code>, an <a class="el" href="classElemental_1_1EntriesView.html" title="An interface for the display of value entries.">EntriesView</a> will always be populated. </p>
</div>
</div>
<a class="anchor" id="ad9bea11e6cb5dc088d028a025e03dd32"></a><!-- doxytag: member="Elemental::value_base::YIELD_COMPARE" ref="ad9bea11e6cb5dc088d028a025e03dd32" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="classElemental_1_1value__base.html#ad9bea11e6cb5dc088d028a025e03dd32">Elemental::value_base::YIELD_COMPARE</a><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates that comparison should be based on values, not definedness. </p>
<p>Returned by <a class="el" href="classElemental_1_1value__base.html#aa05e87556fe6804830d671601698a93f" title="Compares the qualifications of two values.">compare_base()</a> when qualifiers are equivalent. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>libelemental/<a class="el" href="value_8hh.html">value.hh</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Dec 12 2011 12:28:54 for libelemental by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|