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 ComputeCallbackName's supported by the KIM API. More...
#include <KIM_ComputeCallbackName.hpp>
Public Member Functions | |
ComputeCallbackName () | |
Create an uninitialized ComputeCallbackName object. More... | |
ComputeCallbackName (int const id) | |
Create a ComputeCallbackName object with the specified id. More... | |
ComputeCallbackName (std::string const &str) | |
Create a ComputeCallbackName 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== (ComputeCallbackName const &rhs) const |
Compares ComputeCallbackName objects for equality. More... | |
bool | operator!= (ComputeCallbackName const &rhs) const |
Compares ComputeCallbackName objects for inequality. More... | |
std::string const & | ToString () const |
Converts the object to a string. More... | |
Public Attributes | |
int | computeCallbackNameID |
Integer identifying the specific ComputeCallbackName represented. More... | |
An Extensible Enumeration for the ComputeCallbackName's supported by the KIM API.
The enumeration constants are contained in the COMPUTE_CALLBACK_NAME namespace.
Definition at line 51 of file KIM_ComputeCallbackName.hpp.
KIM::ComputeCallbackName::ComputeCallbackName | ( | ) |
Create an uninitialized ComputeCallbackName object.
KIM::ComputeCallbackName::ComputeCallbackName | ( | int const | id | ) |
Create a ComputeCallbackName object with the specified id.
KIM::ComputeCallbackName::ComputeCallbackName | ( | std::string const & | str | ) |
Create a ComputeCallbackName 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::ComputeCallbackName::Known | ( | ) | const |
Determines if the object is a quantity known to the KIM API.
ComputeCallbackName's known to the KIM API are found in the COMPUTE_CALLBACK_NAME namespace.
bool KIM::ComputeCallbackName::operator!= | ( | ComputeCallbackName const & | rhs | ) | const |
Compares ComputeCallbackName objects for inequality.
bool KIM::ComputeCallbackName::operator== | ( | ComputeCallbackName const & | rhs | ) | const |
Compares ComputeCallbackName objects for equality.
std::string const& KIM::ComputeCallbackName::ToString | ( | ) | const |
Converts the object to a string.
int KIM::ComputeCallbackName::computeCallbackNameID |
Integer identifying the specific ComputeCallbackName represented.
Definition at line 64 of file KIM_ComputeCallbackName.hpp.