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 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... | |
An Extensible Enumeration for the TimeUnit's supported by the KIM API.
The enumeration constants are contained in the TIME_UNIT namespace.
Definition at line 49 of file KIM_TimeUnit.hpp.
KIM::TimeUnit::TimeUnit | ( | ) |
Create an uninitialized TimeUnit object.
KIM::TimeUnit::TimeUnit | ( | int const | id | ) |
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.
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.
bool KIM::TimeUnit::operator!= | ( | TimeUnit const & | rhs | ) | const |
Compares TimeUnit objects for inequality.
bool KIM::TimeUnit::operator== | ( | TimeUnit const & | rhs | ) | const |
Compares TimeUnit objects for equality.
std::string const& KIM::TimeUnit::ToString | ( | ) | const |
Converts the object to a string.
int KIM::TimeUnit::timeUnitID |
Integer identifying the specific TimeUnit represented.
Definition at line 61 of file KIM_TimeUnit.hpp.