<!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>The Gnome Chemistry Utils: gcu::FormulaBlock 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">The Gnome Chemistry Utils
 <span id="projectnumber">0.14.17</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="namespacegcu.html">gcu</a></li><li class="navelem"><a class="el" href="classgcu_1_1FormulaBlock.html">FormulaBlock</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_1FormulaBlock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gcu::FormulaBlock 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::FormulaBlock:</div>
<div class="dyncontent">
<div class="center">
<img src="classgcu_1_1FormulaBlock.png" usemap="#gcu::FormulaBlock_map" alt=""/>
<map id="gcu::FormulaBlock_map" name="gcu::FormulaBlock_map">
<area href="classgcu_1_1FormulaElt.html" alt="gcu::FormulaElt" shape="rect" coords="0,0,116,24"/>
</map>
</div></div>
<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:a6cfd916a2670c08ed029ae1af3a495d1"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaBlock.html#a6cfd916a2670c08ed029ae1af3a495d1">~FormulaBlock</a> ()</td></tr>
<tr class="separator:a6cfd916a2670c08ed029ae1af3a495d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf651c6e064d87682dc5686e94240473"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaBlock.html#acf651c6e064d87682dc5686e94240473">Markup</a> ()</td></tr>
<tr class="separator:acf651c6e064d87682dc5686e94240473"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29d128ae409d114119b4e70b8952448a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaBlock.html#a29d128ae409d114119b4e70b8952448a">Text</a> ()</td></tr>
<tr class="separator:a29d128ae409d114119b4e70b8952448a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d381366d13f20e982aea9320aa15b6f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaBlock.html#a8d381366d13f20e982aea9320aa15b6f">BuildRawFormula</a> (std::map< int, int > &raw)</td></tr>
<tr class="separator:a8d381366d13f20e982aea9320aa15b6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30012ed31f4d7c2bd95ccf7528b0be17"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaBlock.html#a30012ed31f4d7c2bd95ccf7528b0be17">GetValence</a> ()</td></tr>
<tr class="separator:a30012ed31f4d7c2bd95ccf7528b0be17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classgcu_1_1FormulaElt"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgcu_1_1FormulaElt')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgcu_1_1FormulaElt.html">gcu::FormulaElt</a></td></tr>
<tr class="memitem:af1eab0c0e8e950ce5c3a3211fb171fc2 inherit pub_methods_classgcu_1_1FormulaElt"><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="separator:af1eab0c0e8e950ce5c3a3211fb171fc2 inherit pub_methods_classgcu_1_1FormulaElt"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acadada2049798143f988afe7cabbe2a7 inherit pub_methods_classgcu_1_1FormulaElt"><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="separator:acadada2049798143f988afe7cabbe2a7 inherit pub_methods_classgcu_1_1FormulaElt"><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:aba4805e38d8d08e2a1d3ca505be41efc"><td class="memItemLeft" align="right" valign="top">std::list< <a class="el" href="classgcu_1_1FormulaElt.html">FormulaElt</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaBlock.html#aba4805e38d8d08e2a1d3ca505be41efc">children</a></td></tr>
<tr class="separator:aba4805e38d8d08e2a1d3ca505be41efc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ad275a4ea5dffac2032cc75c5f41b63"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1FormulaBlock.html#a3ad275a4ea5dffac2032cc75c5f41b63">parenthesis</a></td></tr>
<tr class="separator:a3ad275a4ea5dffac2032cc75c5f41b63"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_attribs_classgcu_1_1FormulaElt"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classgcu_1_1FormulaElt')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classgcu_1_1FormulaElt.html">gcu::FormulaElt</a></td></tr>
<tr class="memitem:a7f55ccd3dee7068ab604ecba0d9c4a4b inherit pub_attribs_classgcu_1_1FormulaElt"><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="separator:a7f55ccd3dee7068ab604ecba0d9c4a4b inherit pub_attribs_classgcu_1_1FormulaElt"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2bba7b1588a7a029af6cdc31b2b25c65 inherit pub_attribs_classgcu_1_1FormulaElt"><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="separator:a2bba7b1588a7a029af6cdc31b2b25c65 inherit pub_attribs_classgcu_1_1FormulaElt"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32d28fde9104f82a6495e87403691b8a inherit pub_attribs_classgcu_1_1FormulaElt"><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>
<tr class="separator:a32d28fde9104f82a6495e87403691b8a inherit pub_attribs_classgcu_1_1FormulaElt"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>class <a class="el" href="classgcu_1_1FormulaBlock.html">FormulaBlock</a> <a class="el" href="formula_8h.html">gcu/formula.h</a> Represents a sub formula delimited by a pair of matching brackets. </p>
<p class="definition">Definition at line <a class="el" href="formula_8h_source.html#l00189">189</a> of file <a class="el" href="formula_8h_source.html">formula.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a6cfd916a2670c08ed029ae1af3a495d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cfd916a2670c08ed029ae1af3a495d1">◆ </a></span>~FormulaBlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual gcu::FormulaBlock::~FormulaBlock </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 class="groupheader">Member Function Documentation</h2>
<a id="a8d381366d13f20e982aea9320aa15b6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d381366d13f20e982aea9320aa15b6f">◆ </a></span>BuildRawFormula()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gcu::FormulaBlock::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">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>Implements <a class="el" href="classgcu_1_1FormulaElt.html#a08a50700b8e01a8e8dc7e7de0d57b455">gcu::FormulaElt</a>.</p>
</div>
</div>
<a id="a30012ed31f4d7c2bd95ccf7528b0be17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30012ed31f4d7c2bd95ccf7528b0be17">◆ </a></span>GetValence()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int gcu::FormulaBlock::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">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>Implements <a class="el" href="classgcu_1_1FormulaElt.html#a912a90e4b8ffb4771247361a00abf537">gcu::FormulaElt</a>.</p>
</div>
</div>
<a id="acf651c6e064d87682dc5686e94240473"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf651c6e064d87682dc5686e94240473">◆ </a></span>Markup()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string gcu::FormulaBlock::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 from <a class="el" href="classgcu_1_1FormulaElt.html#a76cc52d2a13c7c6d793f84fe4128f07a">gcu::FormulaElt</a>.</p>
</div>
</div>
<a id="a29d128ae409d114119b4e70b8952448a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29d128ae409d114119b4e70b8952448a">◆ </a></span>Text()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string gcu::FormulaBlock::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 from <a class="el" href="classgcu_1_1FormulaElt.html#a8e42ff57439e027ce915d154ce25426f">gcu::FormulaElt</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aba4805e38d8d08e2a1d3ca505be41efc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba4805e38d8d08e2a1d3ca505be41efc">◆ </a></span>children</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::list<<a class="el" href="classgcu_1_1FormulaElt.html">FormulaElt</a> *> gcu::FormulaBlock::children</td>
</tr>
</table>
</div><div class="memdoc">
<p>The list of the formula elements delimited by the pair of brackets. </p>
<p class="definition">Definition at line <a class="el" href="formula_8h_source.html#l00221">221</a> of file <a class="el" href="formula_8h_source.html">formula.h</a>.</p>
</div>
</div>
<a id="a3ad275a4ea5dffac2032cc75c5f41b63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ad275a4ea5dffac2032cc75c5f41b63">◆ </a></span>parenthesis</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gcu::FormulaBlock::parenthesis</td>
</tr>
</table>
</div><div class="memdoc">
<p>0 for "()", 1 for "[]" or 2 for "{}". </p>
<p class="definition">Definition at line <a class="el" href="formula_8h_source.html#l00225">225</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 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>
