<!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::Reaction 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_1Reaction.html">Reaction</a>
</div>
</div>
<div class="contents">
<h1>gcp::Reaction Class Reference</h1><!-- doxytag: class="gcp::Reaction" --><!-- doxytag: inherits="gcu::Object" -->
<p>Chemical reaction class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="reaction_8h_source.html">gcp/reaction.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gcp::Reaction:</div>
<div class="dynsection">
<div class="center">
<img src="classgcp_1_1Reaction.gif" usemap="#gcp::Reaction_map" alt=""/>
<map id="gcp::Reaction_map" name="gcp::Reaction_map">
<area href="classgcu_1_1Object.html" alt="gcu::Object" shape="rect" coords="0,0,88,24"/>
</map>
</div>
</div>
<p><a href="classgcp_1_1Reaction-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_1Reaction.html#ad15c5b4ad8191237ab7af2d9caf305a3">Reaction</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Reaction.html#a6bd4b2b8693f501bfb20047c0b17f195">~Reaction</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Reaction.html#a69b136732f3875b39c7786c3f89fe573">Build</a> (std::list< <a class="el" href="classgcu_1_1Object.html">gcu::Object</a> * > &Children) throw (std::invalid_argument)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Reaction.html#a9de3b3a8e6b0c09e390ea35bc90143fc">Transform2D</a> (<a class="el" href="classgcu_1_1Matrix2D.html">gcu::Matrix2D</a> &m, double x, double y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Reaction.html#ac95619e98ff43030de56a70f1e6a1689">BuildContextualMenu</a> (GtkUIManager *UIManager, <a class="el" href="classgcu_1_1Object.html">gcu::Object</a> *object, double x, double y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Reaction.html#a948b28e5711472bff958bf75578d1aa4">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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Reaction.html#ab685cd350215b613741744e4153ff36a">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_1Reaction.html#a0cd5ada3960672705b6026c25606ff46">GetYAlign</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Chemical reaction class. </p>
<p>This class is used for chemical reactions in GChemPaint. It can represent a whole reactions scheme with several steps, although only one step is currently really supported. Acceptable children for an instance of this class are instances of <a class="el" href="classgcp_1_1ReactionArrow.html">ReactionArrow</a> and <a class="el" href="classgcp_1_1ReactionStep.html" title="the list of reactants before or after a reaction arrow.">ReactionStep</a>. </p>
<p>Definition at line <a class="el" href="reaction_8h_source.html#l00042">42</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad15c5b4ad8191237ab7af2d9caf305a3"></a><!-- doxytag: member="gcp::Reaction::Reaction" ref="ad15c5b4ad8191237ab7af2d9caf305a3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::Reaction::Reaction </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new empty <a class="el" href="classgcp_1_1Reaction.html" title="Chemical reaction class.">Reaction</a> instance. </p>
</div>
</div>
<a class="anchor" id="a6bd4b2b8693f501bfb20047c0b17f195"></a><!-- doxytag: member="gcp::Reaction::~Reaction" ref="a6bd4b2b8693f501bfb20047c0b17f195" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gcp::Reaction::~Reaction </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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a69b136732f3875b39c7786c3f89fe573"></a><!-- doxytag: member="gcp::Reaction::Build" ref="a69b136732f3875b39c7786c3f89fe573" args="(std::list< gcu::Object * > &Children)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcp::Reaction::Build </td>
<td>(</td>
<td class="paramtype">std::list< <a class="el" href="classgcu_1_1Object.html">gcu::Object</a> * > & </td>
<td class="paramname"> <em>Children</em></td>
<td> ) </td>
<td> throw (std::invalid_argument)</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>Children</em> </td><td>the list of objects used as children to build the reaction</td></tr>
</table>
</dd>
</dl>
<p>This method is called to build a reactiont from its children. It might fail if reactants are not properly aligned with the reaction arrows. Accepted children are molecules and texts to be used as reactants or products, and reaction arrows. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true in case of success and false if failed. </dd></dl>
</div>
</div>
<a class="anchor" id="ac95619e98ff43030de56a70f1e6a1689"></a><!-- doxytag: member="gcp::Reaction::BuildContextualMenu" ref="ac95619e98ff43030de56a70f1e6a1689" args="(GtkUIManager *UIManager, gcu::Object *object, double x, double y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcp::Reaction::BuildContextualMenu </td>
<td>(</td>
<td class="paramtype">GtkUIManager * </td>
<td class="paramname"> <em>UIManager</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>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>y</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>UIManager</em> </td><td>the GtkUIManager to populate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>the Object on which occured the mouse click. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>x coordinate of the mouse click. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>y coordinate of the mouse click.</td></tr>
</table>
</dd>
</dl>
<p>This method is called to build a contextual menu for the reaction. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if something is added to the UIManager, false otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a0cd5ada3960672705b6026c25606ff46"></a><!-- doxytag: member="gcp::Reaction::GetYAlign" ref="a0cd5ada3960672705b6026c25606ff46" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gcp::Reaction::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 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="ab685cd350215b613741744e4153ff36a"></a><!-- doxytag: member="gcp::Reaction::Load" ref="ab685cd350215b613741744e4153ff36a" args="(xmlNodePtr node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcp::Reaction::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 reaction.</td></tr>
</table>
</dd>
</dl>
<p>Used to load an reaction 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="a948b28e5711472bff958bf75578d1aa4"></a><!-- doxytag: member="gcp::Reaction::OnSignal" ref="a948b28e5711472bff958bf75578d1aa4" args="(gcu::SignalId Signal, gcu::Object *Child)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcp::Reaction::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, 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="a9de3b3a8e6b0c09e390ea35bc90143fc"></a><!-- doxytag: member="gcp::Reaction::Transform2D" ref="a9de3b3a8e6b0c09e390ea35bc90143fc" args="(gcu::Matrix2D &m, double x, double y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcp::Reaction::Transform2D </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcu_1_1Matrix2D.html">gcu::Matrix2D</a> & </td>
<td class="paramname"> <em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></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>m</em> </td><td>the Matrix2D of the transformation. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>the x component of the center of the transformation. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>the y component of the center of the transformation.</td></tr>
</table>
</dd>
</dl>
<p>Used to move and/or transform an object. This virtual method must be overrided by Object derived classes for which it makes sense. The base Object class has no coordinates and the default method calls the corresponding method for every child. </p>
<p>Reimplemented from <a class="el" href="classgcu_1_1Object.html#a69ad6edf7d50950b036f09d9ff86f849">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_8h_source.html">reaction.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
>
97
