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