<!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::Mesomery 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_1Mesomery.html">Mesomery</a>
</div>
</div>
<div class="contents">
<h1>gcp::Mesomery Class Reference</h1><!-- doxytag: class="gcp::Mesomery" --><!-- doxytag: inherits="gcu::Object" -->
<p><code>#include <<a class="el" href="mesomery_8h_source.html">gcp/mesomery.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gcp::Mesomery:</div>
<div class="dynsection">
<div class="center">
<img src="classgcp_1_1Mesomery.gif" usemap="#gcp::Mesomery_map" alt=""/>
<map id="gcp::Mesomery_map" name="gcp::Mesomery_map">
<area href="classgcu_1_1Object.html" alt="gcu::Object" shape="rect" coords="0,0,98,24"/>
</map>
</div>
</div>
<p><a href="classgcp_1_1Mesomery-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_1Mesomery.html#a5505529567e68e09aca1aab05def4bf9">Mesomery</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Mesomery.html#abb7624c8f02e73dc7d907b9e004bbe97">Load</a> (xmlNodePtr node)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Mesomery.html#aedaa2ed8938546102e07953622040432">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_1Mesomery.html#ab11a15c03b70b199234ca152d02026c5">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_1Mesomery.html#acf88bbb7aaf8e540b36f8f617e07d791">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_1Mesomery.html#a633b6603edb16bb43be3b15961aca26d">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_1Mesomery.html#a0403ebc1d6e29a513fd22fff4f411b8b">Validate</a> (bool split)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Mesomery.html#a080800e979255a23eb3d37ab5c6f77e8">Align</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Mesomery.html#a2776f2d3d5d2ba080423dc0a8fb25fca">GetYAlign</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Represents mesomery relationships. </p>
<p>Definition at line <a class="el" href="mesomery_8h_source.html#l00037">37</a> of file <a class="el" href="mesomery_8h_source.html">mesomery.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5505529567e68e09aca1aab05def4bf9"></a><!-- doxytag: member="gcp::Mesomery::Mesomery" ref="a5505529567e68e09aca1aab05def4bf9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::Mesomery::Mesomery </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The default constructor. Builds a new empty mesomery relationship. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a080800e979255a23eb3d37ab5c6f77e8"></a><!-- doxytag: member="gcp::Mesomery::Align" ref="a080800e979255a23eb3d37ab5c6f77e8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcp::Mesomery::Align </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Aligns the children. </p>
</div>
</div>
<a class="anchor" id="aedaa2ed8938546102e07953622040432"></a><!-- doxytag: member="gcp::Mesomery::Build" ref="aedaa2ed8938546102e07953622040432" args="(std::list< gcu::Object * > &Children)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcp::Mesomery::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 molecules and arrow involved in the mesomery.</td></tr>
</table>
</dd>
</dl>
<p>Tries to associate mesomers and arrows so that the relationship is clearly established and aligns the objects. On failure, it throws an std::invalid_argument exception. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success. </dd></dl>
</div>
</div>
<a class="anchor" id="acf88bbb7aaf8e540b36f8f617e07d791"></a><!-- doxytag: member="gcp::Mesomery::BuildContextualMenu" ref="acf88bbb7aaf8e540b36f8f617e07d791" 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::Mesomery::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>Builds the contextual menu for the mesomery. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true (failure would be a bug). </dd></dl>
</div>
</div>
<a class="anchor" id="a2776f2d3d5d2ba080423dc0a8fb25fca"></a><!-- doxytag: member="gcp::Mesomery::GetYAlign" ref="a2776f2d3d5d2ba080423dc0a8fb25fca" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gcp::Mesomery::GetYAlign </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the alignment ordinate of the top mesomer. </dd></dl>
<p>Reimplemented from <a class="el" href="classgcu_1_1Object.html#aedeec6e6b66e1a35e6d2f3ef75c94a09">gcu::Object</a>.</p>
</div>
</div>
<a class="anchor" id="abb7624c8f02e73dc7d907b9e004bbe97"></a><!-- doxytag: member="gcp::Mesomery::Load" ref="abb7624c8f02e73dc7d907b9e004bbe97" args="(xmlNodePtr node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcp::Mesomery::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 arrow.</td></tr>
</table>
</dd>
</dl>
<p>Used to load an arrow 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="a633b6603edb16bb43be3b15961aca26d"></a><!-- doxytag: member="gcp::Mesomery::OnSignal" ref="a633b6603edb16bb43be3b15961aca26d" args="(gcu::SignalId Signal, gcu::Object *Child)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcp::Mesomery::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 one of the molecules or arrows has changed. Realigns if the mesomery is still valid or destroys it.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true to propagate the signal to the parent. </dd></dl>
</div>
</div>
<a class="anchor" id="ab11a15c03b70b199234ca152d02026c5"></a><!-- doxytag: member="gcp::Mesomery::Transform2D" ref="ab11a15c03b70b199234ca152d02026c5" args="(gcu::Matrix2D &m, double x, double y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcp::Mesomery::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>Mesomeries can't be currently rotated. This method don't do anything. It is just there to inhibit the default behavior. </p>
<p>Reimplemented from <a class="el" href="classgcu_1_1Object.html#a69ad6edf7d50950b036f09d9ff86f849">gcu::Object</a>.</p>
</div>
</div>
<a class="anchor" id="a0403ebc1d6e29a513fd22fff4f411b8b"></a><!-- doxytag: member="gcp::Mesomery::Validate" ref="a0403ebc1d6e29a513fd22fff4f411b8b" args="(bool split)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcp::Mesomery::Validate </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>split</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>split</em> </td><td>whether to split the mesomery when arrows are missing.</td></tr>
</table>
</dd>
</dl>
<p>Checks the validity of the mesomery, at least that each arrow is associated with two mesomers and all mesomers are related by arrows. Currently it does not check that the molecules are really mesomeric, but this might be implemented in the future. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the mesomery is valid or could be splitted, false otherwise. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mesomery_8h_source.html">mesomery.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
>
71
