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

#include <KIM_EnergyUnit.hpp>

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

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

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

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

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

Public Attributes
int	energyUnitID
	Integer identifying the specific EnergyUnit represented. More...

Detailed Description

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

The enumeration constants are contained in the ENERGY_UNIT namespace.

See also: KIM_EnergyUnit, kim_energy_unit_module::kim_energy_unit_type

Since: 2.0

Definition at line 46 of file KIM_EnergyUnit.hpp.

Constructor & Destructor Documentation

◆ EnergyUnit() [1/3]

KIM::EnergyUnit::EnergyUnit ( )

Create an uninitialized EnergyUnit object.

Since: 2.0

◆ EnergyUnit() [2/3]

KIM::EnergyUnit::EnergyUnit ( int const id )

Create a EnergyUnit object with the specified id.

Note: This should not be used directly.

Since: 2.0

◆ EnergyUnit() [3/3]

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

Create an EnergyUnit 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_EnergyUnit_FromString, kim_energy_unit_module::kim_from_string

Since: 2.0

Member Function Documentation

◆ Known()

bool KIM::EnergyUnit::Known ( ) const

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

EnergyUnit's known to the KIM API are found in the ENERGY_UNIT namespace.

See also: KIM_EnergyUnit_Known, kim_energy_unit_module::kim_known

Since: 2.0

◆ operator!=()

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

Compares EnergyUnit objects for inequality.

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

See also: KIM_EnergyUnit_NotEqual, kim_energy_unit_module::operator(.ne.)

Since: 2.0

◆ operator==()

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

Compares EnergyUnit objects for equality.

Note: Not all "unknown" objects are equal.

See also: KIM_EnergyUnit_Equal, kim_energy_unit_module::operator(.eq.)

Since: 2.0

◆ ToString()

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

Converts the object to a string.

Returns: A string object representing the EnergyUnit object.

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

See also: KIM_EnergyUnit_ToString, kim_energy_unit_module::kim_to_string

Since: 2.0

Member Data Documentation

◆ energyUnitID

int KIM::EnergyUnit::energyUnitID

Integer identifying the specific EnergyUnit represented.

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

See also: KIM_EnergyUnit::energyUnitID, kim_energy_unit_module::kim_energy_unit_type::energy_unit_id

Since: 2.0

Definition at line 58 of file KIM_EnergyUnit.hpp.

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

latest/cpp/include/KIM_EnergyUnit.hpp

Public Member Functions

Public Attributes