#include <gcu/crystalcleavage.h>
List of all members.
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 crystalcleavage.h.
Constructor & Destructor Documentation
- Parameters:
-
| ccCleavage,: | the cleavage instance to copy. |
The copy constructor.
Member Function Documentation
int& gcu::CrystalCleavage::h |
( |
|
) |
[inline] |
- Returns:
- the Miller's h index of the cleavage plane.
Definition at line 65 of file crystalcleavage.h.
References m_nh.
int& gcu::CrystalCleavage::k |
( |
|
) |
[inline] |
- Returns:
- the Miller's k index of the cleavage plane.
Definition at line 69 of file crystalcleavage.h.
References m_nk.
int& gcu::CrystalCleavage::l |
( |
|
) |
[inline] |
- Returns:
- the Miller's l index of the cleavage plane.
Definition at line 73 of file crystalcleavage.h.
References m_nl.
bool gcu::CrystalCleavage::Load |
( |
xmlNodePtr |
node |
) |
|
- Parameters:
-
| node,: | a pointer to the xmlNode containing the serialized cleavage. |
Used to load an CrystalCleavage instance in memory. The CrystalCleavage must already exist.
- Returns:
- true on succes, false otherwise.
- Parameters:
-
| ccCleavage,: | the cleavage to copy. |
- Returns:
- a CrystalCleavage identical to ccCleavage.
- Parameters:
-
- Returns:
- true if the two cleavages have the same Miller indices and false otherwise.
int& gcu::CrystalCleavage::Planes |
( |
|
) |
[inline] |
xmlNodePtr gcu::CrystalCleavage::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
The documentation for this class was generated from the following file: