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