<!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: gcu::CrystalCleavage 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="namespacegcu.html">gcu</a>::<a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a>
</div>
</div>
<div class="contents">
<h1>gcu::CrystalCleavage Class Reference</h1><!-- doxytag: class="gcu::CrystalCleavage" -->
<p><code>#include <<a class="el" href="crystalcleavage_8h_source.html">gcu/crystalcleavage.h</a>></code></p>
<p><a href="classgcu_1_1CrystalCleavage-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="classgcu_1_1CrystalCleavage.html#ac22314c8d4a43450b057e99e4c8753e4">CrystalCleavage</a> (<a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a> &ccCleavage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1CrystalCleavage.html#af316368f486f3863cfe5002c82bfa1ba">Planes</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1CrystalCleavage.html#ac692490f3e2ab13145ac2b00f4379874">h</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1CrystalCleavage.html#a094669291c4c2da1d7f3a0ef5672ad46">k</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1CrystalCleavage.html#a3e9cfe2577769540d34262bad16ea3f8">l</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1CrystalCleavage.html#aee286777d71b9c0a4ebe8b9282410797">operator=</a> (<a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a> &ccCleavage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1CrystalCleavage.html#a9d37e52d5531c4af696be7da36a4aa77">operator==</a> (<a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a> &ccCleavage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">xmlNodePtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1CrystalCleavage.html#a1c5fedb229b4b1cf1f08511cbcbb3ff2">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="classgcu_1_1CrystalCleavage.html#a3e807d47583525094956ebe50a10e10d">Load</a> (xmlNodePtr node)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1CrystalCleavage.html#a1cfc68568fb71b81296da90515f55e38">m_nh</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1CrystalCleavage.html#addd130fcd3f6d13968e491e657c15f81">m_nk</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1CrystalCleavage.html#a70515f2e7531eb35f3f421814dcea6d3">m_nl</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1CrystalCleavage.html#ae76f9ac2e4319d257d13a0d636d00287">m_nPlanes</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Represents cleavages of a cystal along a plane defined by its Miller indices. A defined number of planes are removed by each cleavage. These are those for which the value hx + ky + lz are the greatest. To remove planes frome the other side of the crystal, change the sign of the three Miller indices. </p>
<p>Definition at line <a class="el" href="crystalcleavage_8h_source.html#l00040">40</a> of file <a class="el" href="crystalcleavage_8h_source.html">crystalcleavage.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac22314c8d4a43450b057e99e4c8753e4"></a><!-- doxytag: member="gcu::CrystalCleavage::CrystalCleavage" ref="ac22314c8d4a43450b057e99e4c8753e4" args="(CrystalCleavage &ccCleavage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::CrystalCleavage::CrystalCleavage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a> & </td>
<td class="paramname"> <em>ccCleavage</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>ccCleavage,:</em> </td><td>the cleavage instance to copy.</td></tr>
</table>
</dd>
</dl>
<p>The copy constructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac692490f3e2ab13145ac2b00f4379874"></a><!-- doxytag: member="gcu::CrystalCleavage::h" ref="ac692490f3e2ab13145ac2b00f4379874" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int& gcu::CrystalCleavage::h </td>
<td>(</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 Miller's h index of the cleavage plane. </dd></dl>
<p>Definition at line <a class="el" href="crystalcleavage_8h_source.html#l00065">65</a> of file <a class="el" href="crystalcleavage_8h_source.html">crystalcleavage.h</a>.</p>
<p>References <a class="el" href="crystalcleavage_8h_source.html#l00104">m_nh</a>.</p>
</div>
</div>
<a class="anchor" id="a094669291c4c2da1d7f3a0ef5672ad46"></a><!-- doxytag: member="gcu::CrystalCleavage::k" ref="a094669291c4c2da1d7f3a0ef5672ad46" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int& gcu::CrystalCleavage::k </td>
<td>(</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 Miller's k index of the cleavage plane. </dd></dl>
<p>Definition at line <a class="el" href="crystalcleavage_8h_source.html#l00069">69</a> of file <a class="el" href="crystalcleavage_8h_source.html">crystalcleavage.h</a>.</p>
<p>References <a class="el" href="crystalcleavage_8h_source.html#l00108">m_nk</a>.</p>
</div>
</div>
<a class="anchor" id="a3e9cfe2577769540d34262bad16ea3f8"></a><!-- doxytag: member="gcu::CrystalCleavage::l" ref="a3e9cfe2577769540d34262bad16ea3f8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int& gcu::CrystalCleavage::l </td>
<td>(</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 Miller's l index of the cleavage plane. </dd></dl>
<p>Definition at line <a class="el" href="crystalcleavage_8h_source.html#l00073">73</a> of file <a class="el" href="crystalcleavage_8h_source.html">crystalcleavage.h</a>.</p>
<p>References <a class="el" href="crystalcleavage_8h_source.html#l00112">m_nl</a>.</p>
</div>
</div>
<a class="anchor" id="a3e807d47583525094956ebe50a10e10d"></a><!-- doxytag: member="gcu::CrystalCleavage::Load" ref="a3e807d47583525094956ebe50a10e10d" args="(xmlNodePtr node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcu::CrystalCleavage::Load </td>
<td>(</td>
<td class="paramtype">xmlNodePtr </td>
<td class="paramname"> <em>node</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>node,:</em> </td><td>a pointer to the xmlNode containing the serialized cleavage.</td></tr>
</table>
</dd>
</dl>
<p>Used to load an <a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a> instance in memory. The <a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a> must already exist. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on succes, false otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="aee286777d71b9c0a4ebe8b9282410797"></a><!-- doxytag: member="gcu::CrystalCleavage::operator=" ref="aee286777d71b9c0a4ebe8b9282410797" args="(CrystalCleavage &ccCleavage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a>& gcu::CrystalCleavage::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a> & </td>
<td class="paramname"> <em>ccCleavage</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>ccCleavage,:</em> </td><td>the cleavage to copy.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a> identical to ccCleavage. </dd></dl>
</div>
</div>
<a class="anchor" id="a9d37e52d5531c4af696be7da36a4aa77"></a><!-- doxytag: member="gcu::CrystalCleavage::operator==" ref="a9d37e52d5531c4af696be7da36a4aa77" args="(CrystalCleavage &ccCleavage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcu::CrystalCleavage::operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a> & </td>
<td class="paramname"> <em>ccCleavage</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>ccCleavage,:</em> </td><td>a <a class="el" href="classgcu_1_1CrystalCleavage.html">CrystalCleavage</a> instance. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the two cleavages have the same Miller indices and false otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="af316368f486f3863cfe5002c82bfa1ba"></a><!-- doxytag: member="gcu::CrystalCleavage::Planes" ref="af316368f486f3863cfe5002c82bfa1ba" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int& gcu::CrystalCleavage::Planes </td>
<td>(</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 planes cleaved. </dd></dl>
<p>Definition at line <a class="el" href="crystalcleavage_8h_source.html#l00061">61</a> of file <a class="el" href="crystalcleavage_8h_source.html">crystalcleavage.h</a>.</p>
<p>References <a class="el" href="crystalcleavage_8h_source.html#l00116">m_nPlanes</a>.</p>
</div>
</div>
<a class="anchor" id="a1c5fedb229b4b1cf1f08511cbcbb3ff2"></a><!-- doxytag: member="gcu::CrystalCleavage::Save" ref="a1c5fedb229b4b1cf1f08511cbcbb3ff2" args="(xmlDocPtr xml) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xmlNodePtr gcu::CrystalCleavage::Save </td>
<td>(</td>
<td class="paramtype">xmlDocPtr </td>
<td class="paramname"> <em>xml</em></td>
<td> ) </td>
<td> const</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 cleavage to the xmlDoc. Each serializable <a class="el" href="classgcu_1_1Object.html">Object</a> should implement this virtual method. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the xmlNode containing the serialized cleavage. </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a1cfc68568fb71b81296da90515f55e38"></a><!-- doxytag: member="gcu::CrystalCleavage::m_nh" ref="a1cfc68568fb71b81296da90515f55e38" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classgcu_1_1CrystalCleavage.html#a1cfc68568fb71b81296da90515f55e38">gcu::CrystalCleavage::m_nh</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Miller's h index. </p>
<p>Definition at line <a class="el" href="crystalcleavage_8h_source.html#l00104">104</a> of file <a class="el" href="crystalcleavage_8h_source.html">crystalcleavage.h</a>.</p>
<p>Referenced by <a class="el" href="crystalcleavage_8h_source.html#l00065">h()</a>.</p>
</div>
</div>
<a class="anchor" id="addd130fcd3f6d13968e491e657c15f81"></a><!-- doxytag: member="gcu::CrystalCleavage::m_nk" ref="addd130fcd3f6d13968e491e657c15f81" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classgcu_1_1CrystalCleavage.html#addd130fcd3f6d13968e491e657c15f81">gcu::CrystalCleavage::m_nk</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Miller's k index. </p>
<p>Definition at line <a class="el" href="crystalcleavage_8h_source.html#l00108">108</a> of file <a class="el" href="crystalcleavage_8h_source.html">crystalcleavage.h</a>.</p>
<p>Referenced by <a class="el" href="crystalcleavage_8h_source.html#l00069">k()</a>.</p>
</div>
</div>
<a class="anchor" id="a70515f2e7531eb35f3f421814dcea6d3"></a><!-- doxytag: member="gcu::CrystalCleavage::m_nl" ref="a70515f2e7531eb35f3f421814dcea6d3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classgcu_1_1CrystalCleavage.html#a70515f2e7531eb35f3f421814dcea6d3">gcu::CrystalCleavage::m_nl</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Miller's l index. </p>
<p>Definition at line <a class="el" href="crystalcleavage_8h_source.html#l00112">112</a> of file <a class="el" href="crystalcleavage_8h_source.html">crystalcleavage.h</a>.</p>
<p>Referenced by <a class="el" href="crystalcleavage_8h_source.html#l00073">l()</a>.</p>
</div>
</div>
<a class="anchor" id="ae76f9ac2e4319d257d13a0d636d00287"></a><!-- doxytag: member="gcu::CrystalCleavage::m_nPlanes" ref="ae76f9ac2e4319d257d13a0d636d00287" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classgcu_1_1CrystalCleavage.html#ae76f9ac2e4319d257d13a0d636d00287">gcu::CrystalCleavage::m_nPlanes</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Number of planes cleaved. </p>
<p>Definition at line <a class="el" href="crystalcleavage_8h_source.html#l00116">116</a> of file <a class="el" href="crystalcleavage_8h_source.html">crystalcleavage.h</a>.</p>
<p>Referenced by <a class="el" href="crystalcleavage_8h_source.html#l00061">Planes()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="crystalcleavage_8h_source.html">crystalcleavage.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 6 18:33:55 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
>
173
