KIM::TEMPERATURE_UNIT Namespace Reference

Contains the enumeration constants and the discovery routines for the TemperatureUnit Extensible Enumeration. More...

Classes
struct	Comparator
	Structure provided for use with std::map. More...

Functions
void	GetNumberOfTemperatureUnits (int *const numberOfTemperatureUnits)
	Get the number of standard TemperatureUnit's defined by the KIM API. More...
int	GetTemperatureUnit (int const index, TemperatureUnit *const temperatureUnit)
	Get the identity of each defined standard TemperatureUnit. More...

Variables
TemperatureUnit const	unused
	Indicates that a TemperatureUnit is not used. More...
TemperatureUnit const	K
	The standard Kelvin unit of temperature. More...

Detailed Description

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

Function Documentation

GetNumberOfTemperatureUnits()

void KIM::TEMPERATURE_UNIT::GetNumberOfTemperatureUnits

(

int *const

numberOfTemperatureUnits

)

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

Parameters

[out]

numberOfTemperatureUnits

The number of standard TemperatureUnit's defined by the KIM API.

See also

KIM_TEMPERATURE_UNIT_GetNumberOfTemperatureUnits, kim_temperature_unit_module::kim_get_number_of_temperature_units

Since

2.0

GetTemperatureUnit()

int KIM::TEMPERATURE_UNIT::GetTemperatureUnit	(	int const	index,
		TemperatureUnit *const	temperatureUnit
	)

Get the identity of each defined standard TemperatureUnit.

Parameters

[in]	index	Zero-based index uniquely labeling each defined standard TemperatureUnit. This index ordering is only guaranteed to be stable during the lifetime of the current process.
[out]	temperatureUnit	The TemperatureUnit object associated with index.

Returns

true if index < 0 or index >= numberOfTemperatureUnits.

false otherwise.

See also

KIM_TEMPERATURE_UNIT_GetTemperatureUnit, kim_temperature_unit_module::kim_get_temperature_unit

Since

2.0

Variable Documentation

K

TemperatureUnit const KIM::TEMPERATURE_UNIT::K

The standard Kelvin unit of temperature.

See also

KIM_TEMPERATURE_UNIT_K, kim_temperature_unit_module::kim_temperature_unit_k

Since

2.0

unused

TemperatureUnit const KIM::TEMPERATURE_UNIT::unused

Indicates that a TemperatureUnit is not used.

See also

KIM_TEMPERATURE_UNIT_unused, kim_temperature_unit_module::kim_temperature_unit_unused

Since

2.0