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