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