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