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

#include <KIM_TimeUnit.hpp>

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

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

	TimeUnit (std::string const &str)
	Create a TimeUnit 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== (TimeUnit const &rhs) const
	Compares TimeUnit objects for equality. More...

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

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

Public Attributes
int	timeUnitID
	Integer identifying the specific TimeUnit represented. More...

Detailed Description

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

The enumeration constants are contained in the TIME_UNIT namespace.

See also: KIM_TimeUnit, kim_time_unit_module::kim_time_unit_type

Since: 2.0

Definition at line 46 of file KIM_TimeUnit.hpp.

Constructor & Destructor Documentation

◆ TimeUnit() [1/3]

KIM::TimeUnit::TimeUnit ( )

Create an uninitialized TimeUnit object.

Since: 2.0

◆ TimeUnit() [2/3]

KIM::TimeUnit::TimeUnit ( int const id )

Create a TimeUnit object with the specified id.

Note: This should not be used directly.

Since: 2.0

◆ TimeUnit() [3/3]

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

Create a TimeUnit 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_TimeUnit_FromString, kim_time_unit_module::kim_from_string

Since: 2.0

Member Function Documentation

◆ Known()

bool KIM::TimeUnit::Known ( ) const

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

TimeUnit's known to the KIM API are found in the TIME_UNIT namespace.

See also: KIM_TimeUnit_Known, kim_time_unit_module::kim_known

Since: 2.0

◆ operator!=()

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

Compares TimeUnit objects for inequality.

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

See also: KIM_TimeUnit_NotEqual, kim_time_unit_module::operator(.ne.)

Since: 2.0

◆ operator==()

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

Compares TimeUnit objects for equality.

Note: Not all "unknown" objects are equal.

See also: KIM_TimeUnit_Equal, kim_time_unit_module::operator(.eq.)

Since: 2.0

◆ ToString()

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

Converts the object to a string.

Returns: A string object representing the TimeUnit object.

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

See also: KIM_TimeUnit_ToString, kim_time_unit_module::kim_to_string

Since: 2.0

Member Data Documentation

◆ timeUnitID

int KIM::TimeUnit::timeUnitID

Integer identifying the specific TimeUnit represented.

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

See also: KIM_TimeUnit::timeUnitID, kim_time_unit_module::kim_time_unit_type::time_unit_id

Since: 2.0

Definition at line 58 of file KIM_TimeUnit.hpp.

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

latest/cpp/include/KIM_TimeUnit.hpp

Public Member Functions

Public Attributes