kim-api
2.1.2+v2.1.2.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
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... | |
An Extensible Enumeration for the LengthUnit's supported by the KIM API.
The enumeration constants are contained in the LENGTH_UNIT namespace.
Definition at line 49 of file KIM_LengthUnit.hpp.
KIM::LengthUnit::LengthUnit | ( | ) |
Create an uninitialized LengthUnit object.
KIM::LengthUnit::LengthUnit | ( | int const | id | ) |
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.
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.
bool KIM::LengthUnit::operator!= | ( | LengthUnit const & | rhs | ) | const |
Compares LengthUnit objects for inequality.
bool KIM::LengthUnit::operator== | ( | LengthUnit const & | rhs | ) | const |
Compares LengthUnit objects for equality.
std::string const& KIM::LengthUnit::ToString | ( | ) | const |
Converts the object to a string.
int KIM::LengthUnit::lengthUnitID |
Integer identifying the specific LengthUnit represented.
Definition at line 61 of file KIM_LengthUnit.hpp.