The Gnome Chemistry Utils 0.13.3
Public Member Functions | Protected Attributes
gcr::Cleavage Class Reference

#include <gcr/cleavage.h>

List of all members.

Public Member Functions

 Cleavage (Cleavage &ccCleavage)
int & Planes ()
int & h ()
int & k ()
int & l ()
Cleavageoperator= (Cleavage &ccCleavage)
bool operator== (Cleavage &ccCleavage)
xmlNodePtr Save (xmlDocPtr xml) const
bool Load (xmlNodePtr node)

Protected Attributes

int m_nh
int m_nk
int m_nl
int m_nPlanes

Detailed Description

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.

Definition at line 40 of file cleavage.h.


Constructor & Destructor Documentation

gcr::Cleavage::Cleavage ( Cleavage ccCleavage)
Parameters:
ccCleavage,:the cleavage instance to copy.

The copy constructor.


Member Function Documentation

int& gcr::Cleavage::h ( ) [inline]
Returns:
the Miller's h index of the cleavage plane.

Definition at line 65 of file cleavage.h.

References m_nh.

int& gcr::Cleavage::k ( ) [inline]
Returns:
the Miller's k index of the cleavage plane.

Definition at line 69 of file cleavage.h.

References m_nk.

int& gcr::Cleavage::l ( ) [inline]
Returns:
the Miller's l index of the cleavage plane.

Definition at line 73 of file cleavage.h.

References m_nl.

bool gcr::Cleavage::Load ( xmlNodePtr  node)
Parameters:
node,:a pointer to the xmlNode containing the serialized cleavage.

Used to load an Cleavage instance in memory. The Cleavage must already exist.

Returns:
true on succes, false otherwise.
Cleavage& gcr::Cleavage::operator= ( Cleavage ccCleavage)
Parameters:
ccCleavage,:the cleavage to copy.
Returns:
a Cleavage identical to ccCleavage.
bool gcr::Cleavage::operator== ( Cleavage ccCleavage)
Parameters:
ccCleavage,:a Cleavage instance.
Returns:
true if the two cleavages have the same Miller indices and false otherwise.
int& gcr::Cleavage::Planes ( ) [inline]
Returns:
the number of planes cleaved.

Definition at line 61 of file cleavage.h.

References m_nPlanes.

xmlNodePtr gcr::Cleavage::Save ( xmlDocPtr  xml) const
Parameters:
xml,:the xmlDoc used to save the document.

Used to save the cleavage to the xmlDoc. Each serializable Object should implement this virtual method.

Returns:
the xmlNode containing the serialized cleavage.

Member Data Documentation

int gcr::Cleavage::m_nh [protected]

Miller's h index.

Definition at line 104 of file cleavage.h.

Referenced by h().

int gcr::Cleavage::m_nk [protected]

Miller's k index.

Definition at line 108 of file cleavage.h.

Referenced by k().

int gcr::Cleavage::m_nl [protected]

Miller's l index.

Definition at line 112 of file cleavage.h.

Referenced by l().

int gcr::Cleavage::m_nPlanes [protected]

Number of planes cleaved.

Definition at line 116 of file cleavage.h.

Referenced by Planes().


The documentation for this class was generated from the following file: