<!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.6"/>
<title>The Gnome Chemistry Utils: reactant.h Source File</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.8</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6719ab1f1f7655efc2fa43f7eb574fd1.html">libs</a></li><li class="navelem"><a class="el" href="dir_69c622b84a81aca1ad0f892f4a5e46bf.html">gcp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">reactant.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="reactant_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// -*- C++ -*-</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * GChemPaint library</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * reactant.h</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Copyright (C) 2004-2011 Jean Bréfort <jean.brefort@normalesup.org></span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * This program is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * modify it under the terms of the GNU General Public License as</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * published by the Free Software Foundation; either version 3 of the</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * GNU General Public License for more details.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * along with this program; if not, write to the Free Software</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * USA</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef GCHEMPAINT_REACTANT_H</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span><span class="preprocessor">#define GCHEMPAINT_REACTANT_H</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="object_8h.html">gcu/object.h</a>></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>gcu {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>UIManager;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> }</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>gcp {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>ReactionStep;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classgcp_1_1Reactant.html"> 46</a></span> <span class="keyword">class </span><a class="code" href="classgcp_1_1Reactant.html">Reactant</a>: <span class="keyword">public</span> <a class="code" href="classgcu_1_1Object.html">gcu::Object</a></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="classgcp_1_1Reactant.html#adc56d3106ed2f956e05b02c9c40299e7">Reactant</a> ();</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">virtual</span> <a class="code" href="classgcp_1_1Reactant.html#a295e03fd97ea0930e53b5df2dcb6e1cd">~Reactant</a> ();</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classgcp_1_1Reactant.html#adc56d3106ed2f956e05b02c9c40299e7">Reactant</a> (<a class="code" href="classgcp_1_1ReactionStep.html">ReactionStep</a>* step, <a class="code" href="classgcu_1_1Object.html">gcu::Object</a>* <span class="keywordtype">object</span>) <span class="keywordflow">throw</span> (std::invalid_argument);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">virtual</span> xmlNodePtr <a class="code" href="classgcp_1_1Reactant.html#a0cc5bb9cfb7982e50af7ffc65ab1136c">Save</a> (xmlDocPtr xml) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classgcp_1_1Reactant.html#a969a9abef810735e9907197b20058e0a">Load</a> (xmlNodePtr node);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classgcp_1_1Reactant.html#a0b4f726bff0e013ca9b014488291b88d"> 83</a></span>  <span class="keywordtype">unsigned</span> <a class="code" href="classgcp_1_1Reactant.html#a0b4f726bff0e013ca9b014488291b88d">GetStoichiometry</a> ()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_Stoich;}</div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classgcp_1_1Reactant.html#a54a789fc738745f6b5ab5310475aec47"> 89</a></span>  <span class="keywordtype">void</span> <a class="code" href="classgcp_1_1Reactant.html#a54a789fc738745f6b5ab5310475aec47">SetStoichiometry</a> (<span class="keywordtype">unsigned</span> coef) {m_Stoich = coef;}</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="classgcp_1_1Reactant.html#a42bf1c6f7e95ace9e608889880c979c4">GetYAlign</a> ();</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">bool</span> <a class="code" href="classgcp_1_1Reactant.html#a647884c6e085bbd62cf0937b670b56f2">BuildContextualMenu</a> (<a class="code" href="classgcu_1_1UIManager.html">gcu::UIManager</a> *UIManager, <a class="code" href="classgcu_1_1Object.html">gcu::Object</a> *<span class="keywordtype">object</span>, <span class="keywordtype">double</span> x, <span class="keywordtype">double</span> y);</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">bool</span> <a class="code" href="classgcp_1_1Reactant.html#a1a184264b6a40f1ea34d206cb4edf9d3">OnSignal</a> (<a class="code" href="namespacegcu.html#af13348b065987fa4ca74ca0fb1ffa48e">gcu::SignalId</a> Signal, <a class="code" href="classgcu_1_1Object.html">gcu::Object</a> *Child);</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">void</span> <a class="code" href="classgcp_1_1Reactant.html#af065bdfb963981b7f16e04d8b99279cf">AddStoichiometry</a> ();</div>
<div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="classgcp_1_1Reactant.html#ad9eef5acdc4ebd587ffb380263e48b4e"> 125</a></span>  <a class="code" href="classgcu_1_1Object.html">gcu::Object</a> *<a class="code" href="classgcp_1_1Reactant.html#ad9eef5acdc4ebd587ffb380263e48b4e">GetChild</a> () {<span class="keywordflow">return</span> Child;}</div>
<div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="classgcp_1_1Reactant.html#ac50ec5561fd8a9b4f3b124f9fa24ef9f"> 129</a></span>  <a class="code" href="classgcu_1_1Object.html">gcu::Object</a> *<a class="code" href="classgcp_1_1Reactant.html#ac50ec5561fd8a9b4f3b124f9fa24ef9f">GetStoichChild</a> () {<span class="keywordflow">return</span> Stoichiometry;}</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  std::string <a class="code" href="classgcp_1_1Reactant.html#a7f2f26deecac350dc792a60b3ca1084a">Name</a> ();</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">unsigned</span> m_Stoich; <span class="comment">//always positive</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <a class="code" href="classgcu_1_1Object.html">gcu::Object</a> *Stoichiometry;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <a class="code" href="classgcu_1_1Object.html">gcu::Object</a> *Child;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> };</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> } <span class="comment">// namespace gcp</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor">#endif // GCHEMPAINT_REACTANT_H</span></div>
<div class="ttc" id="classgcp_1_1Reactant_html_a42bf1c6f7e95ace9e608889880c979c4"><div class="ttname"><a href="classgcp_1_1Reactant.html#a42bf1c6f7e95ace9e608889880c979c4">gcp::Reactant::GetYAlign</a></div><div class="ttdeci">virtual double GetYAlign()</div></div>
<div class="ttc" id="classgcp_1_1Reactant_html_ac50ec5561fd8a9b4f3b124f9fa24ef9f"><div class="ttname"><a href="classgcp_1_1Reactant.html#ac50ec5561fd8a9b4f3b124f9fa24ef9f">gcp::Reactant::GetStoichChild</a></div><div class="ttdeci">gcu::Object * GetStoichChild()</div><div class="ttdef"><b>Definition:</b> <a href="reactant_8h_source.html#l00129">reactant.h:129</a></div></div>
<div class="ttc" id="classgcp_1_1ReactionStep_html"><div class="ttname"><a href="classgcp_1_1ReactionStep.html">gcp::ReactionStep</a></div><div class="ttdoc">the list of reactants before or after a reaction arrow. </div><div class="ttdef"><b>Definition:</b> <a href="reaction-step_8h_source.html#l00049">reaction-step.h:49</a></div></div>
<div class="ttc" id="classgcp_1_1Reactant_html_a295e03fd97ea0930e53b5df2dcb6e1cd"><div class="ttname"><a href="classgcp_1_1Reactant.html#a295e03fd97ea0930e53b5df2dcb6e1cd">gcp::Reactant::~Reactant</a></div><div class="ttdeci">virtual ~Reactant()</div></div>
<div class="ttc" id="classgcu_1_1Object_html"><div class="ttname"><a href="classgcu_1_1Object.html">gcu::Object</a></div><div class="ttdef"><b>Definition:</b> <a href="object_8h_source.html#l00158">object.h:158</a></div></div>
<div class="ttc" id="classgcu_1_1UIManager_html"><div class="ttname"><a href="classgcu_1_1UIManager.html">gcu::UIManager</a></div><div class="ttdoc">base class for a user interface manager </div><div class="ttdef"><b>Definition:</b> <a href="ui-manager_8h_source.html#l00033">ui-manager.h:33</a></div></div>
<div class="ttc" id="classgcp_1_1Reactant_html_a0cc5bb9cfb7982e50af7ffc65ab1136c"><div class="ttname"><a href="classgcp_1_1Reactant.html#a0cc5bb9cfb7982e50af7ffc65ab1136c">gcp::Reactant::Save</a></div><div class="ttdeci">virtual xmlNodePtr Save(xmlDocPtr xml) const </div></div>
<div class="ttc" id="namespacegcu_html_af13348b065987fa4ca74ca0fb1ffa48e"><div class="ttname"><a href="namespacegcu.html#af13348b065987fa4ca74ca0fb1ffa48e">gcu::SignalId</a></div><div class="ttdeci">unsigned SignalId</div><div class="ttdef"><b>Definition:</b> <a href="object_8h_source.html#l00151">object.h:151</a></div></div>
<div class="ttc" id="object_8h_html"><div class="ttname"><a href="object_8h.html">object.h</a></div></div>
<div class="ttc" id="classgcp_1_1Reactant_html_af065bdfb963981b7f16e04d8b99279cf"><div class="ttname"><a href="classgcp_1_1Reactant.html#af065bdfb963981b7f16e04d8b99279cf">gcp::Reactant::AddStoichiometry</a></div><div class="ttdeci">void AddStoichiometry()</div></div>
<div class="ttc" id="classgcp_1_1Reactant_html"><div class="ttname"><a href="classgcp_1_1Reactant.html">gcp::Reactant</a></div><div class="ttdoc">Class for reactants and products of a chemical reaction. </div><div class="ttdef"><b>Definition:</b> <a href="reactant_8h_source.html#l00046">reactant.h:46</a></div></div>
<div class="ttc" id="classgcp_1_1Reactant_html_a1a184264b6a40f1ea34d206cb4edf9d3"><div class="ttname"><a href="classgcp_1_1Reactant.html#a1a184264b6a40f1ea34d206cb4edf9d3">gcp::Reactant::OnSignal</a></div><div class="ttdeci">bool OnSignal(gcu::SignalId Signal, gcu::Object *Child)</div></div>
<div class="ttc" id="classgcp_1_1Reactant_html_adc56d3106ed2f956e05b02c9c40299e7"><div class="ttname"><a href="classgcp_1_1Reactant.html#adc56d3106ed2f956e05b02c9c40299e7">gcp::Reactant::Reactant</a></div><div class="ttdeci">Reactant()</div></div>
<div class="ttc" id="classgcp_1_1Reactant_html_ad9eef5acdc4ebd587ffb380263e48b4e"><div class="ttname"><a href="classgcp_1_1Reactant.html#ad9eef5acdc4ebd587ffb380263e48b4e">gcp::Reactant::GetChild</a></div><div class="ttdeci">gcu::Object * GetChild()</div><div class="ttdef"><b>Definition:</b> <a href="reactant_8h_source.html#l00125">reactant.h:125</a></div></div>
<div class="ttc" id="classgcp_1_1Reactant_html_a647884c6e085bbd62cf0937b670b56f2"><div class="ttname"><a href="classgcp_1_1Reactant.html#a647884c6e085bbd62cf0937b670b56f2">gcp::Reactant::BuildContextualMenu</a></div><div class="ttdeci">bool BuildContextualMenu(gcu::UIManager *UIManager, gcu::Object *object, double x, double y)</div></div>
<div class="ttc" id="classgcp_1_1Reactant_html_a54a789fc738745f6b5ab5310475aec47"><div class="ttname"><a href="classgcp_1_1Reactant.html#a54a789fc738745f6b5ab5310475aec47">gcp::Reactant::SetStoichiometry</a></div><div class="ttdeci">void SetStoichiometry(unsigned coef)</div><div class="ttdef"><b>Definition:</b> <a href="reactant_8h_source.html#l00089">reactant.h:89</a></div></div>
<div class="ttc" id="classgcp_1_1Reactant_html_a0b4f726bff0e013ca9b014488291b88d"><div class="ttname"><a href="classgcp_1_1Reactant.html#a0b4f726bff0e013ca9b014488291b88d">gcp::Reactant::GetStoichiometry</a></div><div class="ttdeci">unsigned GetStoichiometry() const </div><div class="ttdef"><b>Definition:</b> <a href="reactant_8h_source.html#l00083">reactant.h:83</a></div></div>
<div class="ttc" id="classgcp_1_1Reactant_html_a969a9abef810735e9907197b20058e0a"><div class="ttname"><a href="classgcp_1_1Reactant.html#a969a9abef810735e9907197b20058e0a">gcp::Reactant::Load</a></div><div class="ttdeci">virtual bool Load(xmlNodePtr node)</div></div>
<div class="ttc" id="classgcp_1_1Reactant_html_a7f2f26deecac350dc792a60b3ca1084a"><div class="ttname"><a href="classgcp_1_1Reactant.html#a7f2f26deecac350dc792a60b3ca1084a">gcp::Reactant::Name</a></div><div class="ttdeci">std::string Name()</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 8 2014 09:55:01 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.6
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
7edde9f7802946eb105dbcdda3d57c32
>
files
>
839
