/usr/share/doc/libelemental-doc/api/classElemental_1_1Element.html is in libelemental-doc 1.2.0-11.
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 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libelemental: Elemental::Element Class 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">libelemental
 <span id="projectnumber">1.2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<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="namespaceElemental.html">Elemental</a></li><li class="navelem"><a class="el" href="classElemental_1_1Element.html">Element</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="classElemental_1_1Element-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Elemental::Element Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A chemical element.
<a href="classElemental_1_1Element.html#details">More...</a></p>
<p><code>#include <element.hh></code></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:adf91068cd2358187a386adca7b4d26a0"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classElemental_1_1value__base.html">value_base</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Element.html#adf91068cd2358187a386adca7b4d26a0">get_property_base</a> (const <a class="el" href="classElemental_1_1PropertyBase.html">PropertyBase</a> &property) const throw (std::invalid_argument)</td></tr>
<tr class="memdesc:adf91068cd2358187a386adca7b4d26a0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classElemental_1_1value__base.html" title="A base class for qualified values. ">value_base</a> of the value for the given <a class="el" href="classElemental_1_1Property.html" title="A typed property of the chemical elements. ">Property</a>. <a href="#adf91068cd2358187a386adca7b4d26a0">More...</a><br /></td></tr>
<tr class="separator:adf91068cd2358187a386adca7b4d26a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08dd418261c6a2997d25cdb660568961"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a08dd418261c6a2997d25cdb660568961"><td class="memTemplItemLeft" align="right" valign="top">const T & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classElemental_1_1Element.html#a08dd418261c6a2997d25cdb660568961">get_property</a> (const <a class="el" href="classElemental_1_1Property.html">Property</a>< T > &property) const throw (std::invalid_argument)</td></tr>
<tr class="memdesc:a08dd418261c6a2997d25cdb660568961"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value for the given <a class="el" href="classElemental_1_1Property.html" title="A typed property of the chemical elements. ">Property</a>. <a href="#a08dd418261c6a2997d25cdb660568961">More...</a><br /></td></tr>
<tr class="separator:a08dd418261c6a2997d25cdb660568961"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39178e0b8954d91fd90f32324eee6913"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Element.html#a39178e0b8954d91fd90f32324eee6913">make_entries</a> (<a class="el" href="classElemental_1_1EntriesView.html">EntriesView</a> &view) const throw ()</td></tr>
<tr class="memdesc:a39178e0b8954d91fd90f32324eee6913"><td class="mdescLeft"> </td><td class="mdescRight">Generates entries for all properties. <a href="#a39178e0b8954d91fd90f32324eee6913">More...</a><br /></td></tr>
<tr class="separator:a39178e0b8954d91fd90f32324eee6913"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66ba8b6848dc56ad22465919be1105a0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Element.html#a66ba8b6848dc56ad22465919be1105a0">make_entries</a> (<a class="el" href="classElemental_1_1EntriesView.html">EntriesView</a> &view, const <a class="el" href="classElemental_1_1Category.html">Category</a> &category, bool all=false) const throw ()</td></tr>
<tr class="memdesc:a66ba8b6848dc56ad22465919be1105a0"><td class="mdescLeft"> </td><td class="mdescRight">Generates entries for the properties in the given <a class="el" href="classElemental_1_1Category.html" title="A category of properties of the chemical elements. ">Category</a>. <a href="#a66ba8b6848dc56ad22465919be1105a0">More...</a><br /></td></tr>
<tr class="separator:a66ba8b6848dc56ad22465919be1105a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6bde65ee13ab5bbad7052df681bea715"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classElemental_1_1Phase.html">Phase</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Element.html#a6bde65ee13ab5bbad7052df681bea715">get_phase</a> (double tempK=<a class="el" href="namespaceElemental.html#ac8156e556826d157d17bfd2b5bae1405">STANDARD_TEMPERATURE</a>) const throw ()</td></tr>
<tr class="memdesc:a6bde65ee13ab5bbad7052df681bea715"><td class="mdescLeft"> </td><td class="mdescRight">Returns the phase of matter assumed by the element at a temperature. <a href="#a6bde65ee13ab5bbad7052df681bea715">More...</a><br /></td></tr>
<tr class="separator:a6bde65ee13ab5bbad7052df681bea715"><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>
Public Attributes</h2></td></tr>
<tr class="memitem:acab781d78aa5ea397cbaf9bf954e3919"><td class="memItemLeft" align="right" valign="top"><a id="acab781d78aa5ea397cbaf9bf954e3919"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Element.html#acab781d78aa5ea397cbaf9bf954e3919">symbol</a></td></tr>
<tr class="memdesc:acab781d78aa5ea397cbaf9bf954e3919"><td class="mdescLeft"> </td><td class="mdescRight">The chemical symbol for this element. <br /></td></tr>
<tr class="separator:acab781d78aa5ea397cbaf9bf954e3919"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea5de3d2bbf1bd49533f5a0f593bffe5"><td class="memItemLeft" align="right" valign="top"><a id="aea5de3d2bbf1bd49533f5a0f593bffe5"></a>
<a class="el" href="namespaceElemental.html#aa7de3ca4268de4705458e1b9b2154d87">AtomicNumber</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Element.html#aea5de3d2bbf1bd49533f5a0f593bffe5">number</a></td></tr>
<tr class="memdesc:aea5de3d2bbf1bd49533f5a0f593bffe5"><td class="mdescLeft"> </td><td class="mdescRight">The atomic number of this element. <br /></td></tr>
<tr class="separator:aea5de3d2bbf1bd49533f5a0f593bffe5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A chemical element. </p>
<p>The element properties are named in the Properties module. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6bde65ee13ab5bbad7052df681bea715"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bde65ee13ab5bbad7052df681bea715">◆ </a></span>get_phase()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classElemental_1_1Phase.html">Phase</a> Elemental::Element::get_phase </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>tempK</em> = <code><a class="el" href="namespaceElemental.html#ac8156e556826d157d17bfd2b5bae1405">STANDARD_TEMPERATURE</a></code></td><td>)</td>
<td> const</td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2"></td>
</tr>
<tr>
<td align="right"></td><td>)</td><td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the phase of matter assumed by the element at a temperature. </p>
<p>Standard pressure is implied. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tempK</td><td>The temperature, in Kelvin, at which to determine phase. By default, the IUPAC standard temperature. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The phase of matter determined. </dd></dl>
</div>
</div>
<a id="a08dd418261c6a2997d25cdb660568961"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08dd418261c6a2997d25cdb660568961">◆ </a></span>get_property()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const T& Elemental::Element::get_property </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classElemental_1_1Property.html">Property</a>< T > & </td>
<td class="paramname"><em>property</em></td><td>)</td>
<td> const</td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2">std::invalid_argument</td>
</tr>
<tr>
<td align="right"></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>Returns the value for the given <a class="el" href="classElemental_1_1Property.html" title="A typed property of the chemical elements. ">Property</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">property</td><td>The <a class="el" href="classElemental_1_1Element.html" title="A chemical element. ">Element</a> <a class="el" href="classElemental_1_1Property.html" title="A typed property of the chemical elements. ">Property</a> to be returned. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adf91068cd2358187a386adca7b4d26a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf91068cd2358187a386adca7b4d26a0">◆ </a></span>get_property_base()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classElemental_1_1value__base.html">value_base</a>& Elemental::Element::get_property_base </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classElemental_1_1PropertyBase.html">PropertyBase</a> & </td>
<td class="paramname"><em>property</em></td><td>)</td>
<td> const</td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2">std::invalid_argument</td>
</tr>
<tr>
<td align="right"></td><td>)</td><td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <a class="el" href="classElemental_1_1value__base.html" title="A base class for qualified values. ">value_base</a> of the value for the given <a class="el" href="classElemental_1_1Property.html" title="A typed property of the chemical elements. ">Property</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">property</td><td>The <a class="el" href="classElemental_1_1Element.html" title="A chemical element. ">Element</a> <a class="el" href="classElemental_1_1Property.html" title="A typed property of the chemical elements. ">Property</a> to be returned. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a39178e0b8954d91fd90f32324eee6913"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39178e0b8954d91fd90f32324eee6913">◆ </a></span>make_entries() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Elemental::Element::make_entries </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classElemental_1_1EntriesView.html">EntriesView</a> & </td>
<td class="paramname"><em>view</em></td><td>)</td>
<td> const</td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2"></td>
</tr>
<tr>
<td align="right"></td><td>)</td><td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generates entries for all properties. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">view</td><td>An <a class="el" href="classElemental_1_1EntriesView.html" title="An interface for the display of value entries. ">EntriesView</a> to be populated. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a66ba8b6848dc56ad22465919be1105a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66ba8b6848dc56ad22465919be1105a0">◆ </a></span>make_entries() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Elemental::Element::make_entries </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 <a class="el" href="classElemental_1_1Category.html">Category</a> & </td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>all</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2"></td>
</tr>
<tr>
<td align="right"></td><td>)</td><td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generates entries for the properties in the given <a class="el" href="classElemental_1_1Category.html" title="A category of properties of the chemical elements. ">Category</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">view</td><td>An <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">category</td><td>The <a class="el" href="classElemental_1_1Category.html" title="A category of properties of the chemical elements. ">Category</a> whose properties will be provided. </td></tr>
<tr><td class="paramname">all</td><td>For <code>C_GENERAL</code>, controls whether the <a class="el" href="classElemental_1_1EntriesView.html" title="An interface for the display of value entries. ">EntriesView</a> will also receive the element's primary name, symbol, and atomic number. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>libelemental/<a class="el" href="element_8hh.html">element.hh</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.13
</small></address>
</body>
</html>
|