kim-api
2.1.1+v2.1.1.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
Go to the source code of this file.
Classes | |
struct | KIM_Collection |
An Extensible Enumeration for the Collection's supported by the KIM API. More... | |
Typedefs | |
typedef struct KIM_Collection | KIM_Collection |
Convenience typedef. More... | |
Functions | |
KIM_Collection | KIM_Collection_FromString (char const *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... | |
int | KIM_Collection_Known (KIM_Collection const collection) |
Determines if the object is a quantity known to the KIM API. More... | |
int | KIM_Collection_Equal (KIM_Collection const lhs, KIM_Collection const rhs) |
Compares Collection objects for equality. More... | |
int | KIM_Collection_NotEqual (KIM_Collection const lhs, KIM_Collection const rhs) |
Compares Collection objects for inequality. More... | |
char const * | KIM_Collection_ToString (KIM_Collection const collection) |
Converts the object to a string. More... | |
void | KIM_COLLECTION_GetNumberOfCollections (int *const numberOfCollections) |
Get the number of standard Collection's defined by the KIM API. More... | |
int | KIM_COLLECTION_GetCollection (int const index, KIM_Collection *const collection) |
Get the identity of each defined standard Collection. More... | |
Variables | |
KIM_Collection const | KIM_COLLECTION_system |
The standard system Collection. More... | |
KIM_Collection const | KIM_COLLECTION_user |
The standard user Collection. More... | |
KIM_Collection const | KIM_COLLECTION_environmentVariable |
The standard environmentVariable Collection. More... | |
KIM_Collection const | KIM_COLLECTION_currentWorkingDirectory |
The standard currentWorkingDirectory Collection. More... | |
typedef struct KIM_Collection KIM_Collection |
int KIM_Collection_Equal | ( | KIM_Collection const | lhs, |
KIM_Collection const | rhs | ||
) |
Compares Collection objects for equality.
KIM_Collection KIM_Collection_FromString | ( | char const *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.
int KIM_COLLECTION_GetCollection | ( | int const | index, |
KIM_Collection *const | collection | ||
) |
Get the identity of each defined standard Collection.
void KIM_COLLECTION_GetNumberOfCollections | ( | int *const | numberOfCollections | ) |
Get the number of standard Collection's defined by the KIM API.
int KIM_Collection_Known | ( | KIM_Collection const | collection | ) |
Determines if the object is a quantity known to the KIM API.
int KIM_Collection_NotEqual | ( | KIM_Collection const | lhs, |
KIM_Collection const | rhs | ||
) |
Compares Collection objects for inequality.
char const* KIM_Collection_ToString | ( | KIM_Collection const | collection | ) |
Converts the object to a string.
KIM_Collection const KIM_COLLECTION_currentWorkingDirectory |
The standard currentWorkingDirectory
Collection.
KIM_Collection const KIM_COLLECTION_environmentVariable |
The standard environmentVariable
Collection.
KIM_Collection const KIM_COLLECTION_system |
The standard system
Collection.
KIM_Collection const KIM_COLLECTION_user |
The standard user
Collection.