<!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>The Gnome Chemistry Utils: gcp::ReactionStep 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.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<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 class="navpath"><a class="el" href="namespacegcp.html">gcp</a>::<a class="el" href="classgcp_1_1ReactionStep.html">ReactionStep</a>
</div>
</div>
<div class="contents">
<h1>gcp::ReactionStep Class Reference</h1><!-- doxytag: class="gcp::ReactionStep" --><!-- doxytag: inherits="gcu::Object" -->
<p>the list of reactants before or after a reaction arrow.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="reaction-step_8h_source.html">gcp/reaction-step.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gcp::ReactionStep:</div>
<div class="dynsection">
<div class="center">
<img src="classgcp_1_1ReactionStep.gif" usemap="#gcp::ReactionStep_map" alt=""/>
<map id="gcp::ReactionStep_map" name="gcp::ReactionStep_map">
<area href="classgcu_1_1Object.html" alt="gcu::Object" shape="rect" coords="0,0,113,24"/>
</map>
</div>
</div>
<p><a href="classgcp_1_1ReactionStep-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionStep.html#ac2dfaf0c4dec6aa8d47864d94bf3761d">ReactionStep</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionStep.html#a2e207a21a5f5f3e1fae019e08becafe8">~ReactionStep</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionStep.html#ac2cacb75aa79744e0a6accab842d27bb">ReactionStep</a> (<a class="el" href="classgcp_1_1Reaction.html">Reaction</a> *reaction, std::map< double, <a class="el" href="classgcu_1_1Object.html">gcu::Object</a> * > &Children, std::map< <a class="el" href="classgcu_1_1Object.html">gcu::Object</a> *, ArtDRect > Objects)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionStep.html#ae8438608e7219d487447a95f38ad62be">Add</a> (GtkWidget *w) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">xmlNodePtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionStep.html#abbf26ce1420f167113e9646d8148c108">Save</a> (xmlDocPtr xml) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionStep.html#a62b948ca5659277a4e73d889aca787e6">Load</a> (xmlNodePtr node)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionStep.html#aa04ee198904f393f01470a507406daaf">GetYAlign</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionStep.html#a9ac38c8d8845eec085d38520b686d147">OnSignal</a> (<a class="el" href="namespacegcu.html#af13348b065987fa4ca74ca0fb1ffa48e">gcu::SignalId</a> Signal, <a class="el" href="classgcu_1_1Object.html">gcu::Object</a> *Child)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionStep.html#a23dba12219d7b1cfee961db8928fa58b">AddArrow</a> (<a class="el" href="classgcp_1_1ReactionArrow.html">ReactionArrow</a> *arrow)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionStep.html#a9e2e88acf8f08fb80c6ea256088b69bc">RemoveArrow</a> (<a class="el" href="classgcp_1_1ReactionArrow.html">ReactionArrow</a> *arrow)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>the list of reactants before or after a reaction arrow. </p>
<p>The <a class="el" href="classgcp_1_1ReactionStep.html" title="the list of reactants before or after a reaction arrow.">ReactionStep</a> class is a group class which owns a list of reactants and the operators betwwen them. This class is misnamed, since the step is more generally associated with the arrow. It might be renamed ReactionStage in the future if it is possible without making old files unreadable. </p>
<p>Definition at line <a class="el" href="reaction-step_8h_source.html#l00048">48</a> of file <a class="el" href="reaction-step_8h_source.html">reaction-step.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac2dfaf0c4dec6aa8d47864d94bf3761d"></a><!-- doxytag: member="gcp::ReactionStep::ReactionStep" ref="ac2dfaf0c4dec6aa8d47864d94bf3761d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::ReactionStep::ReactionStep </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The default constructor. </p>
</div>
</div>
<a class="anchor" id="a2e207a21a5f5f3e1fae019e08becafe8"></a><!-- doxytag: member="gcp::ReactionStep::~ReactionStep" ref="a2e207a21a5f5f3e1fae019e08becafe8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gcp::ReactionStep::~ReactionStep </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The destructor. </p>
</div>
</div>
<a class="anchor" id="ac2cacb75aa79744e0a6accab842d27bb"></a><!-- doxytag: member="gcp::ReactionStep::ReactionStep" ref="ac2cacb75aa79744e0a6accab842d27bb" args="(Reaction *reaction, std::map< double, gcu::Object * > &Children, std::map< gcu::Object *, ArtDRect > Objects)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::ReactionStep::ReactionStep </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcp_1_1Reaction.html">Reaction</a> * </td>
<td class="paramname"> <em>reaction</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::map< double, <a class="el" href="classgcu_1_1Object.html">gcu::Object</a> * > & </td>
<td class="paramname"> <em>Children</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::map< <a class="el" href="classgcu_1_1Object.html">gcu::Object</a> *, ArtDRect > </td>
<td class="paramname"> <em>Objects</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>reaction</em> </td><td>the parent reaction. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Children</em> </td><td>the reactants from which to build the new instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Objects</em> </td><td>the rectangles bounding the reactants.</td></tr>
</table>
</dd>
</dl>
<p>Buils a new reaction step from the children and adds as many eaction operators as necessary. All children will be horizontally aligned. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae8438608e7219d487447a95f38ad62be"></a><!-- doxytag: member="gcp::ReactionStep::Add" ref="ae8438608e7219d487447a95f38ad62be" args="(GtkWidget *w) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcp::ReactionStep::Add </td>
<td>(</td>
<td class="paramtype">GtkWidget * </td>
<td class="paramname"> <em>w</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>w</em> </td><td>the GtkWidget inside which the step will be displayed.</td></tr>
</table>
</dd>
</dl>
<p>Calledto add a representation of the step in the widget. This is done for all objects but in the case of reaction steps, it does nothing. Just there to override the default. </p>
<p>Reimplemented from <a class="el" href="classgcu_1_1Object.html#afcd1e6f8bc15be563bd33429757d9d21">gcu::Object</a>.</p>
</div>
</div>
<a class="anchor" id="a23dba12219d7b1cfee961db8928fa58b"></a><!-- doxytag: member="gcp::ReactionStep::AddArrow" ref="a23dba12219d7b1cfee961db8928fa58b" args="(ReactionArrow *arrow)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcp::ReactionStep::AddArrow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcp_1_1ReactionArrow.html">ReactionArrow</a> * </td>
<td class="paramname"> <em>arrow</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>arrow</em> </td><td>an arrow related to this instance.</td></tr>
</table>
</dd>
</dl>
<p>Adds an arrow to the list of arrows related to this instance. </p>
<p>Definition at line <a class="el" href="reaction-step_8h_source.html#l00114">114</a> of file <a class="el" href="reaction-step_8h_source.html">reaction-step.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa04ee198904f393f01470a507406daaf"></a><!-- doxytag: member="gcp::ReactionStep::GetYAlign" ref="aa04ee198904f393f01470a507406daaf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gcp::ReactionStep::GetYAlign </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to retrieve the y coordinate for alignment. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>y coordinate used for the reaction step alignment. </dd></dl>
<p>Reimplemented from <a class="el" href="classgcu_1_1Object.html#aedeec6e6b66e1a35e6d2f3ef75c94a09">gcu::Object</a>.</p>
</div>
</div>
<a class="anchor" id="a62b948ca5659277a4e73d889aca787e6"></a><!-- doxytag: member="gcp::ReactionStep::Load" ref="a62b948ca5659277a4e73d889aca787e6" args="(xmlNodePtr node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcp::ReactionStep::Load </td>
<td>(</td>
<td class="paramtype">xmlNodePtr </td>
<td class="paramname"> <em>node</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node,:</em> </td><td>a pointer to the xmlNode containing the serialized step.</td></tr>
</table>
</dd>
</dl>
<p>Used to load a reaction step in memory. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on succes, false otherwise. </dd></dl>
<p>Reimplemented from <a class="el" href="classgcu_1_1Object.html#aa3ee33c25154d8e7bbe1e39de970c489">gcu::Object</a>.</p>
</div>
</div>
<a class="anchor" id="a9ac38c8d8845eec085d38520b686d147"></a><!-- doxytag: member="gcp::ReactionStep::OnSignal" ref="a9ac38c8d8845eec085d38520b686d147" args="(gcu::SignalId Signal, gcu::Object *Child)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcp::ReactionStep::OnSignal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacegcu.html#af13348b065987fa4ca74ca0fb1ffa48e">gcu::SignalId</a> </td>
<td class="paramname"> <em>Signal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgcu_1_1Object.html">gcu::Object</a> * </td>
<td class="paramname"> <em>Child</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Signal</em> </td><td>the appropriate SignalId </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Child</em> </td><td>the child which emitted the signal or NULL</td></tr>
</table>
</dd>
</dl>
<p>This function is called by the framework when a signal has been emitted for the reaction step, when one of its children changed. It should not be called by a program; call Object::EmitSignal instead.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the signal should be propagated to the parent, false otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a9e2e88acf8f08fb80c6ea256088b69bc"></a><!-- doxytag: member="gcp::ReactionStep::RemoveArrow" ref="a9e2e88acf8f08fb80c6ea256088b69bc" args="(ReactionArrow *arrow)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcp::ReactionStep::RemoveArrow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcp_1_1ReactionArrow.html">ReactionArrow</a> * </td>
<td class="paramname"> <em>arrow</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>arrow</em> </td><td>an arrow related to this instance.</td></tr>
</table>
</dd>
</dl>
<p>Removes an arrow from the list of arrows related to this instance when it not anymore relevant. </p>
</div>
</div>
<a class="anchor" id="abbf26ce1420f167113e9646d8148c108"></a><!-- doxytag: member="gcp::ReactionStep::Save" ref="abbf26ce1420f167113e9646d8148c108" args="(xmlDocPtr xml) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xmlNodePtr gcp::ReactionStep::Save </td>
<td>(</td>
<td class="paramtype">xmlDocPtr </td>
<td class="paramname"> <em>xml</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>xml</em> </td><td>the xmlDoc used to save the document.</td></tr>
</table>
</dd>
</dl>
<p>Used to save the reaction step to the xmlDoc. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the xmlNode containing the serialized step. </dd></dl>
<p>Reimplemented from <a class="el" href="classgcu_1_1Object.html#aad462441e79fbd93e158f8294a198d11">gcu::Object</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="reaction-step_8h_source.html">reaction-step.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 6 18:33:54 2009 for The Gnome Chemistry Utils by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
f37f2c0b149d5391818dc5157943cda0
>
files
>
112
