kim-api
2.0.2+v2.0.2.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
An Extensible Enumeration for the DataType's supported by the KIM API. More...
#include <KIM_DataType.hpp>
Public Member Functions | |
DataType () | |
Create an uninitialized DataType object. More... | |
DataType (int const id) | |
Create a DataType object with the specified id. More... | |
DataType (std::string const &str) | |
Create a DataType 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== (DataType const &rhs) const |
Compares DataType objects for equality. More... | |
bool | operator!= (DataType const &rhs) const |
Compares DataType objects for inequality. More... | |
std::string const & | ToString () const |
Converts the object to a string. More... | |
Public Attributes | |
int | dataTypeID |
Integer identifying the specific DataType represented. More... | |
An Extensible Enumeration for the DataType's supported by the KIM API.
The enumeration constants are contained in the DATA_TYPE namespace.
Definition at line 49 of file KIM_DataType.hpp.
KIM::DataType::DataType | ( | ) |
Create an uninitialized DataType object.
KIM::DataType::DataType | ( | int const | id | ) |
KIM::DataType::DataType | ( | std::string const & | str | ) |
Create a DataType 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::DataType::Known | ( | ) | const |
Determines if the object is a quantity known to the KIM API.
DataType's known to the KIM API are found in the DATA_TYPE namespace.
bool KIM::DataType::operator!= | ( | DataType const & | rhs | ) | const |
Compares DataType objects for inequality.
bool KIM::DataType::operator== | ( | DataType const & | rhs | ) | const |
Compares DataType objects for equality.
std::string const& KIM::DataType::ToString | ( | ) | const |
Converts the object to a string.
int KIM::DataType::dataTypeID |
Integer identifying the specific DataType represented.
Definition at line 61 of file KIM_DataType.hpp.