KIM_LengthUnit.h File Reference

Go to the source code of this file.

Classes
struct	KIM_LengthUnit
	An Extensible Enumeration for the LengthUnit's supported by the KIM API. More...

Functions
KIM_LengthUnit	KIM_LengthUnit_FromString (char const *const str)
	Create a LengthUnit object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated.
int	KIM_LengthUnit_Known (KIM_LengthUnit const lengthUnit)
	Determines if the object is a quantity known to the KIM API.
int	KIM_LengthUnit_Equal (KIM_LengthUnit const lhs, KIM_LengthUnit const rhs)
	Compares LengthUnit objects for equality.
int	KIM_LengthUnit_NotEqual (KIM_LengthUnit const lhs, KIM_LengthUnit const rhs)
	Compares LengthUnit objects for inequality.
char const *	KIM_LengthUnit_ToString (KIM_LengthUnit const lengthUnit)
	Converts the object to a string.
void	KIM_LENGTH_UNIT_GetNumberOfLengthUnits (int *const numberOfLengthUnits)
	Get the number of standard LengthUnit's defined by the KIM API.
int	KIM_LENGTH_UNIT_GetLengthUnit (int const index, KIM_LengthUnit *const lengthUnit)
	Get the identity of each defined standard LengthUnit.

Variables
KIM_LengthUnit const	KIM_LENGTH_UNIT_unused
	Indicates that a LengthUnit is not used.
KIM_LengthUnit const	KIM_LENGTH_UNIT_A
	The standard angstrom unit of length.
KIM_LengthUnit const	KIM_LENGTH_UNIT_Bohr
	The standard Bohr unit of length.
KIM_LengthUnit const	KIM_LENGTH_UNIT_cm
	The standard centimeter unit of length.
KIM_LengthUnit const	KIM_LENGTH_UNIT_m
	The standard meter unit of length.
KIM_LengthUnit const	KIM_LENGTH_UNIT_nm
	The standard nanometer unit of length.

Function Documentation

KIM_LENGTH_UNIT_GetLengthUnit()

int KIM_LENGTH_UNIT_GetLengthUnit	(	int const	index,
		KIM_LengthUnit *const	lengthUnit )

Get the identity of each defined standard LengthUnit.

See also

KIM::LENGTH_UNIT::GetLengthUnit, kim_length_unit_module::kim_get_length_unit

Since

2.0

KIM_LENGTH_UNIT_GetNumberOfLengthUnits()

void KIM_LENGTH_UNIT_GetNumberOfLengthUnits

(

int *const

numberOfLengthUnits

)

Get the 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

KIM_LengthUnit_Equal()

int KIM_LengthUnit_Equal	(	KIM_LengthUnit const	lhs,
		KIM_LengthUnit const	rhs )

Compares LengthUnit objects for equality.

See also

KIM::LengthUnit::operator==(), kim_length_unit_module::operator(.eq.)

Since

2.0

KIM_LengthUnit_FromString()

KIM_LengthUnit KIM_LengthUnit_FromString

(

char const *const

str

)

Create a LengthUnit object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated.

See also

KIM::LengthUnit::LengthUnit(std::string const &), kim_length_unit_module::kim_from_string

Since

2.0

KIM_LengthUnit_Known()

int KIM_LengthUnit_Known

(

KIM_LengthUnit const

lengthUnit

)

Determines if the object is a quantity known to the KIM API.

See also

KIM::LengthUnit::Known, kim_length_unit_module::kim_known

Since

2.0

KIM_LengthUnit_NotEqual()

int KIM_LengthUnit_NotEqual	(	KIM_LengthUnit const	lhs,
		KIM_LengthUnit const	rhs )

Compares LengthUnit objects for inequality.

See also

KIM::LengthUnit::operator!=(), kim_length_unit_module::operator(.ne.)

Since

2.0

KIM_LengthUnit_ToString()

char const * KIM_LengthUnit_ToString

(

KIM_LengthUnit const

lengthUnit

)

Converts the object to a string.

See also

KIM::LengthUnit::ToString, kim_length_unit_module::kim_to_string

Since

2.0

Variable Documentation

KIM_LENGTH_UNIT_A

KIM_LengthUnit const KIM_LENGTH_UNIT_A

extern

The standard angstrom unit of length.

See also

KIM::LENGTH_UNIT::A, kim_length_unit_module::kim_length_unit_a

Since

2.0

KIM_LENGTH_UNIT_Bohr

KIM_LengthUnit const KIM_LENGTH_UNIT_Bohr

extern

The standard Bohr unit of length.

See also

KIM::LENGTH_UNIT::Bohr, kim_length_unit_module::kim_length_unit_bohr

Since

2.0

KIM_LENGTH_UNIT_cm

KIM_LengthUnit const KIM_LENGTH_UNIT_cm

extern

The standard centimeter unit of length.

See also

KIM::LENGTH_UNIT::cm, kim_length_unit_module::kim_length_unit_cm

Since

2.0

KIM_LENGTH_UNIT_m

KIM_LengthUnit const KIM_LENGTH_UNIT_m

extern

The standard meter unit of length.

See also

KIM::LENGTH_UNIT::m, kim_length_unit_module::kim_length_unit_m

Since

2.0

KIM_LENGTH_UNIT_nm

KIM_LengthUnit const KIM_LENGTH_UNIT_nm

extern

The standard nanometer unit of length.

See also

KIM::LENGTH_UNIT::nm, kim_length_unit_module::kim_length_unit_nm

Since

2.0

KIM_LENGTH_UNIT_unused

KIM_LengthUnit const KIM_LENGTH_UNIT_unused

extern

Indicates that a LengthUnit is not used.

See also

KIM::LENGTH_UNIT::unused, kim_length_unit_module::kim_length_unit_unused

Since

2.0