<!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::Residue 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_1Residue.html">Residue</a>
</div>
</div>
<div class="contents">
<h1>gcp::Residue Class Reference</h1><!-- doxytag: class="gcp::Residue" --><!-- doxytag: inherits="gcu::Residue" -->
<p>a GChemPaint specific <a class="el" href="classgcp_1_1Residue.html" title="a GChemPaint specific Residue class.">Residue</a> class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gcp_2residue_8h_source.html">gcp/residue.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gcp::Residue:</div>
<div class="dynsection">
<div class="center">
<img src="classgcp_1_1Residue.gif" usemap="#gcp::Residue_map" alt=""/>
<map id="gcp::Residue_map" name="gcp::Residue_map">
<area href="classgcu_1_1Residue.html" alt="gcu::Residue" shape="rect" coords="0,0,84,24"/>
</map>
</div>
</div>
<p><a href="classgcp_1_1Residue-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_1Residue.html#a8abffc8179331a68b93b281e81a64d56">Residue</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#ab6c5d27ed900610f9fda6db127de48b6">Residue</a> (char const *name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#adf5bd7cac64052f5d74fda761ec292ef">Residue</a> (char const *name, char const *symbol, <a class="el" href="classgcp_1_1Molecule.html">Molecule</a> *mol, <a class="el" href="classgcp_1_1Document.html">Document</a> *doc)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#a553f2f0eae1dc9e67ed224ff4a91e213">~Residue</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#af9ad2f79bf2975f6c271745101e4a47d">Load</a> (xmlNodePtr node, bool ro)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#a00e03396a1612a4d3ed3b2d54a17e1b6">operator==</a> (<a class="el" href="classgcu_1_1Molecule.html">gcu::Molecule</a> const &mol) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#a7dc770f4ca4be13c71831c5a8202f249">Register</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#a4512f2d886bec7b148a035da2d4d64b3">Ref</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#a8824965c70456b16c13ab44b32e2278e">Unref</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#ad5384a1d99a443b1c813447eb5682e0d">GetReadOnly</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">xmlNodePtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#a30098abe4b56f055f9340bfa48bbd7af">GetNode</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">xmlNodePtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#a5dbc235bce6550b1220c9b69a991a463">GetMolNode</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#abb5bf5f5412872df89f2c07c23804f95">GetRefs</a> (void)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Residue.html#a7ac9de8f65d858a1b0e41ebf86a02e66">SetPostAddCallback</a> (void(*cb)(<a class="el" href="classgcp_1_1Residue.html">Residue</a> *res))</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>a GChemPaint specific <a class="el" href="classgcp_1_1Residue.html" title="a GChemPaint specific Residue class.">Residue</a> class. </p>
<p>This class adds some GChemPaint specific features to <a class="el" href="classgcu_1_1Residue.html">gcu::Residue</a>. </p>
<p>Definition at line <a class="el" href="gcp_2residue_8h_source.html#l00044">44</a> of file <a class="el" href="gcp_2residue_8h_source.html">gcp/residue.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8abffc8179331a68b93b281e81a64d56"></a><!-- doxytag: member="gcp::Residue::Residue" ref="a8abffc8179331a68b93b281e81a64d56" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::Residue::Residue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The default constructor. </p>
<p>Reimplemented from <a class="el" href="classgcu_1_1Residue.html#a72f5130fa5fd589db8a28aca5f90524e">gcu::Residue</a>.</p>
</div>
</div>
<a class="anchor" id="ab6c5d27ed900610f9fda6db127de48b6"></a><!-- doxytag: member="gcp::Residue::Residue" ref="ab6c5d27ed900610f9fda6db127de48b6" args="(char const *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::Residue::Residue </td>
<td>(</td>
<td class="paramtype">char const * </td>
<td class="paramname"> <em>name</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>name</em> </td><td>the name of the new residue.</td></tr>
</table>
</dd>
</dl>
<p>Constructs a new residue with the given name. </p>
</div>
</div>
<a class="anchor" id="adf5bd7cac64052f5d74fda761ec292ef"></a><!-- doxytag: member="gcp::Residue::Residue" ref="adf5bd7cac64052f5d74fda761ec292ef" args="(char const *name, char const *symbol, Molecule *mol, Document *doc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::Residue::Residue </td>
<td>(</td>
<td class="paramtype">char const * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"> <em>symbol</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgcp_1_1Molecule.html">Molecule</a> * </td>
<td class="paramname"> <em>mol</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgcp_1_1Document.html">Document</a> * </td>
<td class="paramname"> <em>doc</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>name</em> </td><td>the name of the new residue. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>symbol</em> </td><td>the symbol of the new residue. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mol</em> </td><td>the molecule represented by the residue. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>doc</em> </td><td>the document owning the residue when it does not have global scope.</td></tr>
</table>
</dd>
</dl>
<p>Constructs a new residue using the given arguments. </p>
</div>
</div>
<a class="anchor" id="a553f2f0eae1dc9e67ed224ff4a91e213"></a><!-- doxytag: member="gcp::Residue::~Residue" ref="a553f2f0eae1dc9e67ed224ff4a91e213" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gcp::Residue::~Residue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The destructor. </p>
<p>Reimplemented from <a class="el" href="classgcu_1_1Residue.html#a62b6b69527e5db5bbb70b9fefa64cba8">gcu::Residue</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5dbc235bce6550b1220c9b69a991a463"></a><!-- doxytag: member="gcp::Residue::GetMolNode" ref="a5dbc235bce6550b1220c9b69a991a463" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::Residue::GetMolNode </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the XML node representing the molecule associated to the residue. </dd></dl>
<p>Definition at line <a class="el" href="gcp_2residue_8h_source.html#l00122">122</a> of file <a class="el" href="gcp_2residue_8h_source.html">gcp/residue.h</a>.</p>
</div>
</div>
<a class="anchor" id="a30098abe4b56f055f9340bfa48bbd7af"></a><!-- doxytag: member="gcp::Residue::GetNode" ref="a30098abe4b56f055f9340bfa48bbd7af" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::Residue::GetNode </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the XML node representing the residue. </dd></dl>
<p>Definition at line <a class="el" href="gcp_2residue_8h_source.html#l00118">118</a> of file <a class="el" href="gcp_2residue_8h_source.html">gcp/residue.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad5384a1d99a443b1c813447eb5682e0d"></a><!-- doxytag: member="gcp::Residue::GetReadOnly" ref="ad5384a1d99a443b1c813447eb5682e0d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::Residue::GetReadOnly </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the residue is read-only or false if it can be modified. </dd></dl>
<p>Definition at line <a class="el" href="gcp_2residue_8h_source.html#l00114">114</a> of file <a class="el" href="gcp_2residue_8h_source.html">gcp/residue.h</a>.</p>
</div>
</div>
<a class="anchor" id="abb5bf5f5412872df89f2c07c23804f95"></a><!-- doxytag: member="gcp::Residue::GetRefs" ref="abb5bf5f5412872df89f2c07c23804f95" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::Residue::GetRefs </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of uses of the residue in currently opened documents. This is used to prevent deleting an used writeable residue. </dd></dl>
<p>Definition at line <a class="el" href="gcp_2residue_8h_source.html#l00127">127</a> of file <a class="el" href="gcp_2residue_8h_source.html">gcp/residue.h</a>.</p>
</div>
</div>
<a class="anchor" id="af9ad2f79bf2975f6c271745101e4a47d"></a><!-- doxytag: member="gcp::Residue::Load" ref="af9ad2f79bf2975f6c271745101e4a47d" args="(xmlNodePtr node, bool ro)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcp::Residue::Load </td>
<td>(</td>
<td class="paramtype">xmlNodePtr </td>
<td class="paramname"> <em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>ro</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>node</em> </td><td>an XML node. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ro</em> </td><td>whether the residue is read-only or not.</td></tr>
</table>
</dd>
</dl>
<p>Loads data GChemPaint specific data from <em>node</em>, and calls <a class="el" href="classgcu_1_1Residue.html#a6e15c7aa2b9889faaf76ad58ba19fa2e">gcu::Residue::Load()</a>. </p>
</div>
</div>
<a class="anchor" id="a00e03396a1612a4d3ed3b2d54a17e1b6"></a><!-- doxytag: member="gcp::Residue::operator==" ref="a00e03396a1612a4d3ed3b2d54a17e1b6" args="(gcu::Molecule const &mol) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcp::Residue::operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcu_1_1Molecule.html">gcu::Molecule</a> const & </td>
<td class="paramname"> <em>mol</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>mol</em> </td><td>the molecule to compare to the residue.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if <em>mol</em> is identical to the group represented by this residue, including the pseudo atom. </dd></dl>
<p>Reimplemented from <a class="el" href="classgcu_1_1Residue.html#a57c96641d1c58fcc6f343188fbe93c77">gcu::Residue</a>.</p>
</div>
</div>
<a class="anchor" id="a4512f2d886bec7b148a035da2d4d64b3"></a><!-- doxytag: member="gcp::Residue::Ref" ref="a4512f2d886bec7b148a035da2d4d64b3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcp::Residue::Ref </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Increments the references number by one unit. </p>
</div>
</div>
<a class="anchor" id="a7dc770f4ca4be13c71831c5a8202f249"></a><!-- doxytag: member="gcp::Residue::Register" ref="a7dc770f4ca4be13c71831c5a8202f249" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcp::Residue::Register </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Registers the residue in the database. </p>
</div>
</div>
<a class="anchor" id="a7ac9de8f65d858a1b0e41ebf86a02e66"></a><!-- doxytag: member="gcp::Residue::SetPostAddCallback" ref="a7ac9de8f65d858a1b0e41ebf86a02e66" args="(void(*cb)(Residue *res))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void gcp::Residue::SetPostAddCallback </td>
<td>(</td>
<td class="paramtype">void(*)(<a class="el" href="classgcp_1_1Residue.html">Residue</a> *res) </td>
<td class="paramname"> <em>cb</em></td>
<td> ) </td>
<td><code> [inline, static]</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>cb</em> </td><td>a callback to call when a new residue is registered.</td></tr>
</table>
</dd>
</dl>
<p>When a new residue is registered in the database, it might be necessary to execute some extra code, hence this static method. Only one callback can be registered in this version. </p>
<p>Definition at line <a class="el" href="gcp_2residue_8h_source.html#l00106">106</a> of file <a class="el" href="gcp_2residue_8h_source.html">gcp/residue.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8824965c70456b16c13ab44b32e2278e"></a><!-- doxytag: member="gcp::Residue::Unref" ref="a8824965c70456b16c13ab44b32e2278e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcp::Residue::Unref </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decreases the references number by one unit. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gcp_2residue_8h_source.html">gcp/residue.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
>
115
