kim-api  2.1.4-git+v2.1.3-git-1-g7847914a.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Public Member Functions | Public Attributes | List of all members
KIM::LengthUnit Class Reference

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

#include <KIM_LengthUnit.hpp>

Public Member Functions

 LengthUnit ()
 Create an uninitialized LengthUnit object. More...
 
 LengthUnit (int const id)
 Create a LengthUnit object with the specified id. More...
 
 LengthUnit (std::string 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. More...
 
bool Known () const
 Determines if the object is a quantity known to the KIM API. More...
 
bool operator== (LengthUnit const &rhs) const
 Compares LengthUnit objects for equality. More...
 
bool operator!= (LengthUnit const &rhs) const
 Compares LengthUnit objects for inequality. More...
 
std::string const & ToString () const
 Converts the object to a string. More...
 

Public Attributes

int lengthUnitID
 Integer identifying the specific LengthUnit represented. More...
 

Detailed Description

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

The enumeration constants are contained in the LENGTH_UNIT namespace.

See also
KIM_LengthUnit, kim_length_unit_module::kim_length_unit_type
Since
2.0

Definition at line 49 of file KIM_LengthUnit.hpp.

Constructor & Destructor Documentation

◆ LengthUnit() [1/3]

KIM::LengthUnit::LengthUnit ( )

Create an uninitialized LengthUnit object.

Since
2.0

◆ LengthUnit() [2/3]

KIM::LengthUnit::LengthUnit ( int const  id)

Create a LengthUnit object with the specified id.

Note
This should not be used directly.
Since
2.0

◆ LengthUnit() [3/3]

KIM::LengthUnit::LengthUnit ( std::string 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_FromString, kim_length_unit_module::kim_from_string
Since
2.0

Member Function Documentation

◆ Known()

bool KIM::LengthUnit::Known ( ) const

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

LengthUnit's known to the KIM API are found in the LENGTH_UNIT namespace.

See also
KIM_LengthUnit_Known, kim_length_unit_module::kim_known
Since
2.0

◆ operator!=()

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

Compares LengthUnit objects for inequality.

Note
It is possible for two "unknown" objects to be not equal.
See also
KIM_LengthUnit_NotEqual, kim_length_unit_module::operator(.ne.)
Since
2.0

◆ operator==()

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

Compares LengthUnit objects for equality.

Note
Not all "unknown" objects are equal.
See also
KIM_LengthUnit_Equal, kim_length_unit_module::operator(.eq.)
Since
2.0

◆ ToString()

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

Converts the object to a string.

Returns
A string object representing the LengthUnit object.
Note
If the LengthUnit object does not correspond to a value defined by the KIM API, then the string "unknown" is returned.
See also
KIM_LengthUnit_ToString, kim_length_unit_module::kim_to_string
Since
2.0

Member Data Documentation

◆ lengthUnitID

int KIM::LengthUnit::lengthUnitID

Integer identifying the specific LengthUnit represented.

Note
This should not be directly accessed and is only public for cross-language reasons.
See also
KIM_LengthUnit::lengthUnitID, kim_length_unit_module::kim_length_unit_type::length_unit_id
Since
2.0

Definition at line 61 of file KIM_LengthUnit.hpp.


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