<!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"/>
<title>The Gnome Chemistry Utils: gcu::FormulaElt 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 style="padding-left: 0.5em;">
<div id="projectname">The Gnome Chemistry Utils
 <span id="projectnumber">0.14.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<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>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="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.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="namespacegcu.html">gcu</a></li><li class="navelem"><a class="el" href="classgcu_1_1FormulaElt.html">FormulaElt</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="classgcu_1_1FormulaElt-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gcu::FormulaElt Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="formula_8h_source.html">formula.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gcu::FormulaElt:</div>
<div class="dyncontent">
<div class="center">
<img src="classgcu_1_1FormulaElt.png" usemap="#gcu::FormulaElt_map" alt=""/>
<map id="gcu::FormulaElt_map" name="gcu::FormulaElt_map">
<area href="classgcu_1_1FormulaAtom.html" alt="gcu::FormulaAtom" shape="rect" coords="0,56,130,80"/>
<area href="classgcu_1_1FormulaBlock.html" alt="gcu::FormulaBlock" shape="rect" coords="140,56,270,80"/>
<area href="classgcu_1_1FormulaResidue.html" title="Residue." alt="gcu::FormulaResidue" shape="rect" coords="280,56,410,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af1eab0c0e8e950ce5c3a3211fb171fc2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaElt.html#af1eab0c0e8e950ce5c3a3211fb171fc2">FormulaElt</a> ()</td></tr>
<tr class="memitem:acadada2049798143f988afe7cabbe2a7"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaElt.html#acadada2049798143f988afe7cabbe2a7">~FormulaElt</a> ()</td></tr>
<tr class="memitem:a76cc52d2a13c7c6d793f84fe4128f07a"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaElt.html#a76cc52d2a13c7c6d793f84fe4128f07a">Markup</a> ()</td></tr>
<tr class="memitem:a8e42ff57439e027ce915d154ce25426f"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaElt.html#a8e42ff57439e027ce915d154ce25426f">Text</a> ()</td></tr>
<tr class="memitem:a08a50700b8e01a8e8dc7e7de0d57b455"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaElt.html#a08a50700b8e01a8e8dc7e7de0d57b455">BuildRawFormula</a> (std::map< int, int > &raw)=0</td></tr>
<tr class="memitem:a912a90e4b8ffb4771247361a00abf537"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaElt.html#a912a90e4b8ffb4771247361a00abf537">GetValence</a> ()=0</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7f55ccd3dee7068ab604ecba0d9c4a4b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaElt.html#a7f55ccd3dee7068ab604ecba0d9c4a4b">stoich</a></td></tr>
<tr class="memitem:a2bba7b1588a7a029af6cdc31b2b25c65"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaElt.html#a2bba7b1588a7a029af6cdc31b2b25c65">start</a></td></tr>
<tr class="memitem:a32d28fde9104f82a6495e87403691b8a"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaElt.html#a32d28fde9104f82a6495e87403691b8a">end</a></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>class <a class="el" href="classgcu_1_1FormulaElt.html">FormulaElt</a> <a class="el" href="formula_8h.html">gcu/formula.h</a> Bas class for elements found in a formula. </p>
<p>Definition at line <a class="el" href="formula_8h_source.html#l00103">103</a> of file <a class="el" href="formula_8h_source.html">formula.h</a>.</p>
</div><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af1eab0c0e8e950ce5c3a3211fb171fc2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::FormulaElt::FormulaElt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The constructor. </p>
</div>
</div>
<a class="anchor" id="acadada2049798143f988afe7cabbe2a7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual gcu::FormulaElt::~FormulaElt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The destructor. </p>
</div>
</div>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a08a50700b8e01a8e8dc7e7de0d57b455"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void gcu::FormulaElt::BuildRawFormula </td>
<td>(</td>
<td class="paramtype">std::map< int, int > & </td>
<td class="paramname"><em>raw</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">raw</td><td>where to put the result</td></tr>
</table>
</dd>
</dl>
<p>Adds the number of atoms of each element to the map taking the stoichiometry coefficient into account. </p>
<p>Implemented in <a class="el" href="classgcu_1_1FormulaResidue.html#a6f58c8a43bde3d4c9f9fa47caa462795">gcu::FormulaResidue</a>, <a class="el" href="classgcu_1_1FormulaBlock.html#a8d381366d13f20e982aea9320aa15b6f">gcu::FormulaBlock</a>, and <a class="el" href="classgcu_1_1FormulaAtom.html#a087c6dc30e4faf8ad12c07d1380b8211">gcu::FormulaAtom</a>.</p>
</div>
</div>
<a class="anchor" id="a912a90e4b8ffb4771247361a00abf537"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int gcu::FormulaElt::GetValence </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the (most probable) valence of the element. </dd></dl>
<p>Implemented in <a class="el" href="classgcu_1_1FormulaResidue.html#ac0f8028a11ddabeabf57c990edda4fd8">gcu::FormulaResidue</a>, <a class="el" href="classgcu_1_1FormulaBlock.html#a30012ed31f4d7c2bd95ccf7528b0be17">gcu::FormulaBlock</a>, and <a class="el" href="classgcu_1_1FormulaAtom.html#afc657924ed05abc49b383d9820d5bfce">gcu::FormulaAtom</a>.</p>
</div>
</div>
<a class="anchor" id="a76cc52d2a13c7c6d793f84fe4128f07a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string gcu::FormulaElt::Markup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the string representation of the element as a markup. </dd></dl>
<p>Reimplemented in <a class="el" href="classgcu_1_1FormulaResidue.html#aea9d0af58133907701496bdf8a39f216">gcu::FormulaResidue</a>, <a class="el" href="classgcu_1_1FormulaBlock.html#acf651c6e064d87682dc5686e94240473">gcu::FormulaBlock</a>, and <a class="el" href="classgcu_1_1FormulaAtom.html#a0bbe8e6741b6584a4264b3497bc777f9">gcu::FormulaAtom</a>.</p>
</div>
</div>
<a class="anchor" id="a8e42ff57439e027ce915d154ce25426f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string gcu::FormulaElt::Text </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the string representation of the element as raw text. </dd></dl>
<p>Reimplemented in <a class="el" href="classgcu_1_1FormulaResidue.html#aad3fca53d48084689db755595dcf2244">gcu::FormulaResidue</a>, <a class="el" href="classgcu_1_1FormulaBlock.html#a29d128ae409d114119b4e70b8952448a">gcu::FormulaBlock</a>, and <a class="el" href="classgcu_1_1FormulaAtom.html#aaed2da3254eed84843258f75fa239e9f">gcu::FormulaAtom</a>.</p>
</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="a32d28fde9104f82a6495e87403691b8a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned gcu::FormulaElt::end</td>
</tr>
</table>
</div><div class="memdoc">
<p>The end index in bytes of the element in the formula input string. </p>
<p>Definition at line <a class="el" href="formula_8h_source.html#l00144">144</a> of file <a class="el" href="formula_8h_source.html">formula.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2bba7b1588a7a029af6cdc31b2b25c65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned gcu::FormulaElt::start</td>
</tr>
</table>
</div><div class="memdoc">
<p>The start index in bytes of the element in the formula input string. </p>
<p>Definition at line <a class="el" href="formula_8h_source.html#l00140">140</a> of file <a class="el" href="formula_8h_source.html">formula.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7f55ccd3dee7068ab604ecba0d9c4a4b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gcu::FormulaElt::stoich</td>
</tr>
</table>
</div><div class="memdoc">
<p>The stoichiometry coefficient associated with he element. </p>
<p>Definition at line <a class="el" href="formula_8h_source.html#l00136">136</a> of file <a class="el" href="formula_8h_source.html">formula.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="formula_8h_source.html">formula.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 14 2013 17:34:31 for The Gnome Chemistry Utils by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
