<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>The Gnome Chemistry Utils: gcr::Cleavage Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">The Gnome Chemistry Utils
 <span id="projectnumber">0.14.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacegcr.html">gcr</a></li><li class="navelem"><a class="el" href="classgcr_1_1Cleavage.html">Cleavage</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classgcr_1_1Cleavage-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gcr::Cleavage Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="cleavage_8h_source.html">gcr/cleavage.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa8c318a6ff41472d6c606ebfba48e14b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#aa8c318a6ff41472d6c606ebfba48e14b">Cleavage</a> (<a class="el" href="classgcr_1_1Cleavage.html">Cleavage</a> &ccCleavage)</td></tr>
<tr class="memitem:a5ec2b587efbded98e62d6ddbf2411836"><td class="memItemLeft" align="right" valign="top">unsigned & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#a5ec2b587efbded98e62d6ddbf2411836">Planes</a> ()</td></tr>
<tr class="memitem:a215a51379cebd50b3a0db87dd3eda092"><td class="memItemLeft" align="right" valign="top">int & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#a215a51379cebd50b3a0db87dd3eda092">h</a> ()</td></tr>
<tr class="memitem:acdf3b03e1676d69814cbc0dd16b835f9"><td class="memItemLeft" align="right" valign="top">int & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#acdf3b03e1676d69814cbc0dd16b835f9">k</a> ()</td></tr>
<tr class="memitem:afdabebdbe56b48810b453279403d5627"><td class="memItemLeft" align="right" valign="top">int & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#afdabebdbe56b48810b453279403d5627">l</a> ()</td></tr>
<tr class="memitem:ab4c95fade6c23a834144f495239e351d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcr_1_1Cleavage.html">Cleavage</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#ab4c95fade6c23a834144f495239e351d">operator=</a> (<a class="el" href="classgcr_1_1Cleavage.html">Cleavage</a> &ccCleavage)</td></tr>
<tr class="memitem:ae4cffd12aeeab48729eb265fdac382d7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#ae4cffd12aeeab48729eb265fdac382d7">operator==</a> (<a class="el" href="classgcr_1_1Cleavage.html">Cleavage</a> &ccCleavage)</td></tr>
<tr class="memitem:a139acef1e3d120a68bf4503f5c044541"><td class="memItemLeft" align="right" valign="top">xmlNodePtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#a139acef1e3d120a68bf4503f5c044541">Save</a> (xmlDocPtr xml) const </td></tr>
<tr class="memitem:af139f760c86376400d24f820f05dcbe1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#af139f760c86376400d24f820f05dcbe1">Load</a> (xmlNodePtr node)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a5f36a7b6b925c1347d5819135fcecd98"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#a5f36a7b6b925c1347d5819135fcecd98">m_nh</a></td></tr>
<tr class="memitem:a4a51506905723d4b148a0500acc3c536"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#a4a51506905723d4b148a0500acc3c536">m_nk</a></td></tr>
<tr class="memitem:add25dc8ba091c56bfab79aeb933b1c54"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#add25dc8ba091c56bfab79aeb933b1c54">m_nl</a></td></tr>
<tr class="memitem:a26ee4ec1ba58cca03e245c2c9ead72ff"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Cleavage.html#a26ee4ec1ba58cca03e245c2c9ead72ff">m_nPlanes</a></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><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="cleavage_8h_source.html#l00040">40</a> of file <a class="el" href="cleavage_8h_source.html">cleavage.h</a>.</p>
</div><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa8c318a6ff41472d6c606ebfba48e14b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcr::Cleavage::Cleavage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcr_1_1Cleavage.html">Cleavage</a> & </td>
<td class="paramname"><em>ccCleavage</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ccCleavage,:</td><td>the cleavage instance to copy.</td></tr>
</table>
</dd>
</dl>
<p>The copy constructor. </p>
</div>
</div>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a215a51379cebd50b3a0db87dd3eda092"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int& gcr::Cleavage::h </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the Miller's h index of the cleavage plane. </dd></dl>
<p>Definition at line <a class="el" href="cleavage_8h_source.html#l00065">65</a> of file <a class="el" href="cleavage_8h_source.html">cleavage.h</a>.</p>
<p>References <a class="el" href="cleavage_8h_source.html#l00104">m_nh</a>.</p>
</div>
</div>
<a class="anchor" id="acdf3b03e1676d69814cbc0dd16b835f9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int& gcr::Cleavage::k </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the Miller's k index of the cleavage plane. </dd></dl>
<p>Definition at line <a class="el" href="cleavage_8h_source.html#l00069">69</a> of file <a class="el" href="cleavage_8h_source.html">cleavage.h</a>.</p>
<p>References <a class="el" href="cleavage_8h_source.html#l00108">m_nk</a>.</p>
</div>
</div>
<a class="anchor" id="afdabebdbe56b48810b453279403d5627"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int& gcr::Cleavage::l </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the Miller's l index of the cleavage plane. </dd></dl>
<p>Definition at line <a class="el" href="cleavage_8h_source.html#l00073">73</a> of file <a class="el" href="cleavage_8h_source.html">cleavage.h</a>.</p>
<p>References <a class="el" href="cleavage_8h_source.html#l00112">m_nl</a>.</p>
</div>
</div>
<a class="anchor" id="af139f760c86376400d24f820f05dcbe1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcr::Cleavage::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 class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node,:</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="classgcr_1_1Cleavage.html">Cleavage</a> instance in memory. The <a class="el" href="classgcr_1_1Cleavage.html">Cleavage</a> must already exist. </p>
<dl class="section return"><dt>Returns</dt><dd>true on succes, false otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="ab4c95fade6c23a834144f495239e351d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgcr_1_1Cleavage.html">Cleavage</a>& gcr::Cleavage::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcr_1_1Cleavage.html">Cleavage</a> & </td>
<td class="paramname"><em>ccCleavage</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ccCleavage,:</td><td>the cleavage to copy.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="classgcr_1_1Cleavage.html">Cleavage</a> identical to ccCleavage. </dd></dl>
</div>
</div>
<a class="anchor" id="ae4cffd12aeeab48729eb265fdac382d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gcr::Cleavage::operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcr_1_1Cleavage.html">Cleavage</a> & </td>
<td class="paramname"><em>ccCleavage</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ccCleavage,:</td><td>a <a class="el" href="classgcr_1_1Cleavage.html">Cleavage</a> instance. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the two cleavages have the same Miller indices and false otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a5ec2b587efbded98e62d6ddbf2411836"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned& gcr::Cleavage::Planes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the number of planes cleaved. </dd></dl>
<p>Definition at line <a class="el" href="cleavage_8h_source.html#l00061">61</a> of file <a class="el" href="cleavage_8h_source.html">cleavage.h</a>.</p>
<p>References <a class="el" href="cleavage_8h_source.html#l00116">m_nPlanes</a>.</p>
</div>
</div>
<a class="anchor" id="a139acef1e3d120a68bf4503f5c044541"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xmlNodePtr gcr::Cleavage::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 class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">xml,:</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 Object should implement this virtual method. </p>
<dl class="section return"><dt>Returns</dt><dd>the xmlNode containing the serialized cleavage. </dd></dl>
</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="a5f36a7b6b925c1347d5819135fcecd98"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int gcr::Cleavage::m_nh</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Miller's h index. </p>
<p>Definition at line <a class="el" href="cleavage_8h_source.html#l00104">104</a> of file <a class="el" href="cleavage_8h_source.html">cleavage.h</a>.</p>
<p>Referenced by <a class="el" href="cleavage_8h_source.html#l00065">h()</a>.</p>
</div>
</div>
<a class="anchor" id="a4a51506905723d4b148a0500acc3c536"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int gcr::Cleavage::m_nk</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Miller's k index. </p>
<p>Definition at line <a class="el" href="cleavage_8h_source.html#l00108">108</a> of file <a class="el" href="cleavage_8h_source.html">cleavage.h</a>.</p>
<p>Referenced by <a class="el" href="cleavage_8h_source.html#l00069">k()</a>.</p>
</div>
</div>
<a class="anchor" id="add25dc8ba091c56bfab79aeb933b1c54"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int gcr::Cleavage::m_nl</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Miller's l index. </p>
<p>Definition at line <a class="el" href="cleavage_8h_source.html#l00112">112</a> of file <a class="el" href="cleavage_8h_source.html">cleavage.h</a>.</p>
<p>Referenced by <a class="el" href="cleavage_8h_source.html#l00073">l()</a>.</p>
</div>
</div>
<a class="anchor" id="a26ee4ec1ba58cca03e245c2c9ead72ff"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned gcr::Cleavage::m_nPlanes</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of planes cleaved. </p>
<p>Definition at line <a class="el" href="cleavage_8h_source.html#l00116">116</a> of file <a class="el" href="cleavage_8h_source.html">cleavage.h</a>.</p>
<p>Referenced by <a class="el" href="cleavage_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="cleavage_8h_source.html">cleavage.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 14 2013 17:34:31 for The Gnome Chemistry Utils by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
