<!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::FragmentResidue 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_1FragmentResidue.html">FragmentResidue</a>
</div>
</div>
<div class="contents">
<h1>gcp::FragmentResidue Class Reference</h1><!-- doxytag: class="gcp::FragmentResidue" --><!-- doxytag: inherits="gcp::FragmentAtom" -->
<p><code>#include <<a class="el" href="fragment-residue_8h_source.html">gcp/fragment-residue.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gcp::FragmentResidue:</div>
<div class="dynsection">
<div class="center">
<img src="classgcp_1_1FragmentResidue.gif" usemap="#gcp::FragmentResidue_map" alt=""/>
<map id="gcp::FragmentResidue_map" name="gcp::FragmentResidue_map">
<area href="classgcp_1_1FragmentAtom.html" alt="gcp::FragmentAtom" shape="rect" coords="73,168,210,192"/>
<area href="classgcp_1_1Atom.html" alt="gcp::Atom" shape="rect" coords="73,112,210,136"/>
<area href="classgcu_1_1Atom.html" alt="gcu::Atom" shape="rect" coords="0,56,137,80"/>
<area href="classgcu_1_1DialogOwner.html" alt="gcu::DialogOwner" shape="rect" coords="147,56,284,80"/>
<area href="classgcu_1_1Object.html" alt="gcu::Object" shape="rect" coords="0,0,137,24"/>
</map>
</div>
</div>
<p><a href="classgcp_1_1FragmentResidue-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_1FragmentResidue.html#ac289508c94e626d6e9751b0ff54724d7">FragmentResidue</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1FragmentResidue.html#a8cfdae311cc1b0f6714c07509540c42b">FragmentResidue</a> (<a class="el" href="classgcp_1_1Fragment.html">Fragment</a> *fragment, char const *symbol)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1FragmentResidue.html#af9ab67db818de05b9203e610edaec523">~FragmentResidue</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">xmlNodePtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1FragmentResidue.html#aa9860847b53b41355982dc5d1d6c058a">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_1FragmentResidue.html#add2c5572e5eed7d7d88d30f44c76226a">Load</a> (xmlNodePtr node)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1FragmentResidue.html#a59e073a6cf4f835025ff5cbf0777f5f9">SetResidue</a> (<a class="el" href="classgcp_1_1Residue.html">Residue</a> const *res)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1FragmentResidue.html#a83de50e53fbc175fbcc8026ec77c7d4a">GetSymbol</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcp_1_1Residue.html">Residue</a> const * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1FragmentResidue.html#a821aea8665733466a4a691296ed88a66">GetResidue</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1FragmentResidue.html#a9b863b263a89acefaae1fefcb0e0dd04">GetAbbrev</a> (void)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Represents a residue inside a atoms group (see <a class="el" href="classgcp_1_1Fragment.html" title="Atoms groups.">gcp::Fragment</a> class). </p>
<p>Definition at line <a class="el" href="fragment-residue_8h_source.html#l00038">38</a> of file <a class="el" href="fragment-residue_8h_source.html">fragment-residue.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac289508c94e626d6e9751b0ff54724d7"></a><!-- doxytag: member="gcp::FragmentResidue::FragmentResidue" ref="ac289508c94e626d6e9751b0ff54724d7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::FragmentResidue::FragmentResidue </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="a8cfdae311cc1b0f6714c07509540c42b"></a><!-- doxytag: member="gcp::FragmentResidue::FragmentResidue" ref="a8cfdae311cc1b0f6714c07509540c42b" args="(Fragment *fragment, char const *symbol)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::FragmentResidue::FragmentResidue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcp_1_1Fragment.html">Fragment</a> * </td>
<td class="paramname"> <em>fragment</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"> <em>symbol</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>fragment</em> </td><td>the fragment containing the residue symbol. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>symbol</em> </td><td>the residue symbol.</td></tr>
</table>
</dd>
</dl>
<p>Constructs a <a class="el" href="classgcp_1_1FragmentResidue.html">FragmentResidue</a> as a child of <em>fragment</em>. </p>
</div>
</div>
<a class="anchor" id="af9ab67db818de05b9203e610edaec523"></a><!-- doxytag: member="gcp::FragmentResidue::~FragmentResidue" ref="af9ab67db818de05b9203e610edaec523" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gcp::FragmentResidue::~FragmentResidue </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="a9b863b263a89acefaae1fefcb0e0dd04"></a><!-- doxytag: member="gcp::FragmentResidue::GetAbbrev" ref="a9b863b263a89acefaae1fefcb0e0dd04" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::FragmentResidue::GetAbbrev </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 used symbol for the residue. </dd></dl>
<p>Definition at line <a class="el" href="fragment-residue_8h_source.html#l00089">89</a> of file <a class="el" href="fragment-residue_8h_source.html">fragment-residue.h</a>.</p>
</div>
</div>
<a class="anchor" id="a821aea8665733466a4a691296ed88a66"></a><!-- doxytag: member="gcp::FragmentResidue::GetResidue" ref="a821aea8665733466a4a691296ed88a66" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcp::FragmentResidue::GetResidue </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 associated residue. </dd></dl>
<p>Definition at line <a class="el" href="fragment-residue_8h_source.html#l00085">85</a> of file <a class="el" href="fragment-residue_8h_source.html">fragment-residue.h</a>.</p>
</div>
</div>
<a class="anchor" id="a83de50e53fbc175fbcc8026ec77c7d4a"></a><!-- doxytag: member="gcp::FragmentResidue::GetSymbol" ref="a83de50e53fbc175fbcc8026ec77c7d4a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const gchar* gcp::FragmentResidue::GetSymbol </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the symbol of this <a class="el" href="classgcp_1_1Residue.html" title="a GChemPaint specific Residue class.">Residue</a>. </dd></dl>
<p>Reimplemented from <a class="el" href="classgcu_1_1Atom.html#a4371e488d9548ea7d9b6ee48c3be83bc">gcu::Atom</a>.</p>
</div>
</div>
<a class="anchor" id="add2c5572e5eed7d7d88d30f44c76226a"></a><!-- doxytag: member="gcp::FragmentResidue::Load" ref="add2c5572e5eed7d7d88d30f44c76226a" args="(xmlNodePtr node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcp::FragmentResidue::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>an XML node.</td></tr>
</table>
</dd>
</dl>
<p>Loads the symbol and associated resdue from <em>node</em>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, false otherwise. </dd></dl>
<p>Reimplemented from <a class="el" href="classgcp_1_1FragmentAtom.html#aca577c2cb21b8fcb47fe0790cc41458a">gcp::FragmentAtom</a>.</p>
</div>
</div>
<a class="anchor" id="aa9860847b53b41355982dc5d1d6c058a"></a><!-- doxytag: member="gcp::FragmentResidue::Save" ref="aa9860847b53b41355982dc5d1d6c058a" args="(xmlDocPtr xml) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xmlNodePtr gcp::FragmentResidue::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>Builds an XML node representing this instance. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the new XML node or NULL on error. </dd></dl>
<p>Reimplemented from <a class="el" href="classgcp_1_1FragmentAtom.html#a143e33f55d77547cc9be39f2c5e248d0">gcp::FragmentAtom</a>.</p>
</div>
</div>
<a class="anchor" id="a59e073a6cf4f835025ff5cbf0777f5f9"></a><!-- doxytag: member="gcp::FragmentResidue::SetResidue" ref="a59e073a6cf4f835025ff5cbf0777f5f9" args="(Residue const *res)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcp::FragmentResidue::SetResidue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcp_1_1Residue.html">Residue</a> const * </td>
<td class="paramname"> <em>res</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>res</em> </td><td>the residue correspondig to the symbol.</td></tr>
</table>
</dd>
</dl>
<p>Sets the associated residue. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="fragment-residue_8h_source.html">fragment-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
>
62
