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