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