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).
|
Contains the enumeration constants and the discovery routines for the Collection Extensible Enumeration. More...
Classes | |
struct | Comparator |
Structure provided for use with std::map. More... | |
Functions | |
void | GetNumberOfCollections (int *const numberOfCollections) |
Get the number of standard Collection's defined by the KIM API. More... | |
int | GetCollection (int const index, Collection *const collection) |
Get the identity of each defined standard Collection. More... | |
Variables | |
Collection const | system |
The standard system Collection. More... | |
Collection const | user |
The standard user Collection. More... | |
Collection const | environmentVariable |
The standard environmentVariable Collection. More... | |
Collection const | currentWorkingDirectory |
The standard currentWorkingDirectory Collection. More... | |
Contains the enumeration constants and the discovery routines for the Collection Extensible Enumeration.
int KIM::COLLECTION::GetCollection | ( | int const | index, |
Collection *const | collection | ||
) |
Get the identity of each defined standard Collection.
[in] | index | Zero-based index uniquely labeling each defined standard Collection. This index ordering is only guaranteed to be stable during the lifetime of the current process. |
[out] | collection | The Collection object associated with index . |
true
if index < 0
or index >= numberOfCollections
. false
otherwise.void KIM::COLLECTION::GetNumberOfCollections | ( | int *const | numberOfCollections | ) |
Get the number of standard Collection's defined by the KIM API.
[out] | numberOfCollections | The number of standard Collection's defined by the KIM API. |
Collection const KIM::COLLECTION::currentWorkingDirectory |
The standard currentWorkingDirectory
Collection.
The current working directory collection.
Collection const KIM::COLLECTION::environmentVariable |
The standard environmentVariable
Collection.
The environment variable collection.
Collection const KIM::COLLECTION::system |
Collection const KIM::COLLECTION::user |