kim-api  2.1.4-git+v2.1.3-git-3-g4c859c7f.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Classes | Functions | Variables
KIM::LENGTH_UNIT Namespace Reference

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...
 

Detailed Description

Contains the enumeration constants and the discovery routines for the LengthUnit Extensible Enumeration.

Function Documentation

◆ GetLengthUnit()

int KIM::LENGTH_UNIT::GetLengthUnit ( int const  index,
LengthUnit *const  lengthUnit 
)

Get the identity of each defined standard LengthUnit.

Parameters
[in]indexZero-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]lengthUnitThe LengthUnit object associated with index.
Returns
true if index < 0 or index >= numberOfLengthUnits.
false otherwise.
See also
KIM_LENGTH_UNIT_GetLengthUnit, kim_length_unit_module::kim_get_length_unit
Since
2.0

◆ GetNumberOfLengthUnits()

void KIM::LENGTH_UNIT::GetNumberOfLengthUnits ( int *const  numberOfLengthUnits)

Get the number of standard LengthUnit's defined by the KIM API.

Parameters
[out]numberOfLengthUnitsThe number of standard LengthUnit's defined by the KIM API.
See also
KIM_LENGTH_UNIT_GetNumberOfLengthUnits, kim_length_unit_module::kim_get_number_of_length_units
Since
2.0

Variable Documentation

◆ A

LengthUnit const KIM::LENGTH_UNIT::A

The standard angstrom unit of length.

See also
KIM_LENGTH_UNIT_A, kim_length_unit_module::kim_length_unit_a
Since
2.0

◆ Bohr

LengthUnit const KIM::LENGTH_UNIT::Bohr

The standard Bohr unit of length.

See also
KIM_LENGTH_UNIT_Bohr, kim_length_unit_module::kim_length_unit_bohr
Since
2.0

◆ cm

LengthUnit const KIM::LENGTH_UNIT::cm

The standard centimeter unit of length.

See also
KIM_LENGTH_UNIT_cm, kim_length_unit_module::kim_length_unit_cm
Since
2.0

◆ m

LengthUnit const KIM::LENGTH_UNIT::m

The standard meter unit of length.

See also
KIM_LENGTH_UNIT_m, kim_length_unit_module::kim_length_unit_m
Since
2.0

◆ nm

LengthUnit const KIM::LENGTH_UNIT::nm

The standard nanometer unit of length.

See also
KIM_LENGTH_UNIT_nm, kim_length_unit_module::kim_length_unit_nm
Since
2.0

◆ unused

LengthUnit const KIM::LENGTH_UNIT::unused

Indicates that a LengthUnit is not used.

See also
KIM_LENGTH_UNIT_unused, kim_length_unit_module::kim_length_unit_unused
Since
2.0