kim-api
2.0.2+v2.0.2.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
Contains the enumeration constants and the discovery routines for the LengthUnit Extensible Enumeration. More...
Classes | |
struct | Comparator |
Structure provided for use with std::map. More... | |
Functions | |
void | GetNumberOfLengthUnits (int *const numberOfLengthUnits) |
Get the number of standard LengthUnit's defined by the KIM API. More... | |
int | GetLengthUnit (int const index, LengthUnit *const lengthUnit) |
Get the identity of each defined standard LengthUnit. More... | |
Variables | |
LengthUnit const | unused |
Indicates that a LengthUnit is not used. More... | |
LengthUnit const | A |
The standard angstrom unit of length. More... | |
LengthUnit const | Bohr |
The standard Bohr unit of length. More... | |
LengthUnit const | cm |
The standard centimeter unit of length. More... | |
LengthUnit const | m |
The standard meter unit of length. More... | |
LengthUnit const | nm |
The standard nanometer unit of length. More... | |
Contains the enumeration constants and the discovery routines for the LengthUnit Extensible Enumeration.
int KIM::LENGTH_UNIT::GetLengthUnit | ( | int const | index, |
LengthUnit *const | lengthUnit | ||
) |
Get the identity of each defined standard LengthUnit.
[in] | index | Zero-based index uniquely labeling each defined standard LengthUnit. This index ordering is only guaranteed to be stable during the lifetime of the current process. |
[out] | lengthUnit | The LengthUnit object associated with index . |
true
if index < 0
or index >= numberOfLengthUnits
. false
otherwise.void KIM::LENGTH_UNIT::GetNumberOfLengthUnits | ( | int *const | numberOfLengthUnits | ) |
Get the number of standard LengthUnit's defined by the KIM API.
[out] | numberOfLengthUnits | The number of standard LengthUnit's defined by the KIM API. |
LengthUnit const KIM::LENGTH_UNIT::A |
The standard angstrom unit of length.
LengthUnit const KIM::LENGTH_UNIT::Bohr |
The standard Bohr unit of length.
LengthUnit const KIM::LENGTH_UNIT::cm |
The standard centimeter unit of length.
LengthUnit const KIM::LENGTH_UNIT::m |
The standard meter unit of length.
LengthUnit const KIM::LENGTH_UNIT::nm |
The standard nanometer unit of length.
LengthUnit const KIM::LENGTH_UNIT::unused |
Indicates that a LengthUnit is not used.