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).
|
Go to the source code of this file.
Classes | |
struct | KIM_CollectionItemType |
An Extensible Enumeration for the CollectionItemType's supported by the KIM API. More... | |
Typedefs | |
typedef struct KIM_CollectionItemType | KIM_CollectionItemType |
Convenience typedef. More... | |
Functions | |
KIM_CollectionItemType | KIM_CollectionItemType_FromString (char const *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... | |
int | KIM_CollectionItemType_Known (KIM_CollectionItemType const collectionItemType) |
Determines if the object is a quantity known to the KIM API. More... | |
int | KIM_CollectionItemType_Equal (KIM_CollectionItemType const lhs, KIM_CollectionItemType const rhs) |
Compares CollectionItemType objects for equality. More... | |
int | KIM_CollectionItemType_NotEqual (KIM_CollectionItemType const lhs, KIM_CollectionItemType const rhs) |
Compares CollectionItemType objects for inequality. More... | |
char const * | KIM_CollectionItemType_ToString (KIM_CollectionItemType const collectionItemType) |
Converts the object to a string. More... | |
void | KIM_COLLECTION_ITEM_TYPE_GetNumberOfCollectionItemTypes (int *const numberOfCollectionItemTypes) |
Get the number of standard CollectionItemType's defined by the KIM API. More... | |
int | KIM_COLLECTION_ITEM_TYPE_GetCollectionItemType (int const index, KIM_CollectionItemType *const collectionItemType) |
Get the identity of each defined standard CollectionItemType. More... | |
Variables | |
KIM_CollectionItemType const | KIM_COLLECTION_ITEM_TYPE_modelDriver |
The standard modelDriver CollectionItemType. More... | |
KIM_CollectionItemType const | KIM_COLLECTION_ITEM_TYPE_portableModel |
The standard portableModel CollectionItemType. More... | |
KIM_CollectionItemType const | KIM_COLLECTION_ITEM_TYPE_simulatorModel |
The standard simulatorModel CollectionItemType. More... | |
typedef struct KIM_CollectionItemType KIM_CollectionItemType |
int KIM_COLLECTION_ITEM_TYPE_GetCollectionItemType | ( | int const | index, |
KIM_CollectionItemType *const | collectionItemType | ||
) |
Get the identity of each defined standard CollectionItemType.
void KIM_COLLECTION_ITEM_TYPE_GetNumberOfCollectionItemTypes | ( | int *const | numberOfCollectionItemTypes | ) |
Get the number of standard CollectionItemType's defined by the KIM API.
int KIM_CollectionItemType_Equal | ( | KIM_CollectionItemType const | lhs, |
KIM_CollectionItemType const | rhs | ||
) |
Compares CollectionItemType objects for equality.
KIM_CollectionItemType KIM_CollectionItemType_FromString | ( | char const *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.
int KIM_CollectionItemType_Known | ( | KIM_CollectionItemType const | collectionItemType | ) |
Determines if the object is a quantity known to the KIM API.
int KIM_CollectionItemType_NotEqual | ( | KIM_CollectionItemType const | lhs, |
KIM_CollectionItemType const | rhs | ||
) |
Compares CollectionItemType objects for inequality.
char const* KIM_CollectionItemType_ToString | ( | KIM_CollectionItemType const | collectionItemType | ) |
Converts the object to a string.
KIM_CollectionItemType const KIM_COLLECTION_ITEM_TYPE_modelDriver |
The standard modelDriver
CollectionItemType.
KIM_CollectionItemType const KIM_COLLECTION_ITEM_TYPE_portableModel |
The standard portableModel
CollectionItemType.
KIM_CollectionItemType const KIM_COLLECTION_ITEM_TYPE_simulatorModel |
The standard simulatorModel
CollectionItemType.