An Extensible Enumeration for the TemperatureUnit's supported by the KIM API. More...

#include <KIM_TemperatureUnit.hpp>

Public Member Functions
	TemperatureUnit ()
	Create an uninitialized TemperatureUnit object. More...

	TemperatureUnit (int const id)
	Create a TemperatureUnit object with the specified id. More...

	TemperatureUnit (std::string const &str)
	Create a TemperatureUnit 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. More...

bool	Known () const
	Determines if the object is a quantity known to the KIM API. More...

bool	operator== (TemperatureUnit const &rhs) const
	Compares TemperatureUnit objects for equality. More...

bool	operator!= (TemperatureUnit const &rhs) const
	Compares TemperatureUnit objects for inequality. More...

std::string const &	ToString () const
	Converts the object to a string. More...

Public Attributes
int	temperatureUnitID
	Integer identifying the specific TemperatureUnit represented. More...

Detailed Description

An Extensible Enumeration for the TemperatureUnit's supported by the KIM API.

The enumeration constants are contained in the TEMPERATURE_UNIT namespace.

See also: KIM_TemperatureUnit, kim_temperature_unit_module::kim_temperature_unit_type

Since: 2.0

Definition at line 47 of file KIM_TemperatureUnit.hpp.

Constructor & Destructor Documentation

◆ TemperatureUnit() [1/3]

KIM::TemperatureUnit::TemperatureUnit ( )

Create an uninitialized TemperatureUnit object.

Since: 2.0

◆ TemperatureUnit() [2/3]

KIM::TemperatureUnit::TemperatureUnit ( int const id )

Create a TemperatureUnit object with the specified id.

Note: This should not be used directly.

Since: 2.0

◆ TemperatureUnit() [3/3]

KIM::TemperatureUnit::TemperatureUnit ( std::string const & str )

Create a TemperatureUnit 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_TemperatureUnit_FromString, kim_temperature_unit_module::kim_from_string

Since: 2.0

Member Function Documentation

◆ Known()

bool KIM::TemperatureUnit::Known ( ) const

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

TemperatureUnit's known to the KIM API are found in the TEMPERATURE_UNIT namespace.

See also: KIM_TemperatureUnit_Known, kim_temperature_unit_module::kim_known

Since: 2.0

◆ operator!=()

bool KIM::TemperatureUnit::operator!= ( TemperatureUnit const & rhs ) const

Compares TemperatureUnit objects for inequality.

Note: It is possible for two "unknown" objects to be not equal.

See also: KIM_TemperatureUnit_NotEqual, kim_temperature_unit_module::operator(.ne.)

Since: 2.0

◆ operator==()

bool KIM::TemperatureUnit::operator== ( TemperatureUnit const & rhs ) const

Compares TemperatureUnit objects for equality.

Note: Not all "unknown" objects are equal.

See also: KIM_TemperatureUnit_Equal, kim_temperature_unit_module::operator(.eq.)

Since: 2.0

◆ ToString()

std::string const& KIM::TemperatureUnit::ToString ( ) const

Converts the object to a string.

Returns: A string object representing the TemperatureUnit object.

Note: If the TemperatureUnit object does not correspond to a value defined by the KIM API, then the string "unknown" is returned.

See also: KIM_TemperatureUnit_ToString, kim_temperature_unit_module::kim_to_string

Since: 2.0

Member Data Documentation

◆ temperatureUnitID

int KIM::TemperatureUnit::temperatureUnitID

Integer identifying the specific TemperatureUnit represented.

Note: This should not be directly accessed and is only public for cross-language reasons.

See also: KIM_TemperatureUnit::temperatureUnitID, kim_temperature_unit_module::kim_temperature_unit_type::temperature_unit_id

Since: 2.0

Definition at line 60 of file KIM_TemperatureUnit.hpp.

The documentation for this class was generated from the following file:

devel/cpp/include/KIM_TemperatureUnit.hpp

Public Member Functions

Public Attributes