kim-api  2.2.0-git+9ce3041f.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Classes | Functions | Variables
KIM::COLLECTION_ITEM_TYPE Namespace Reference

Contains the enumeration constants and the discovery routines for the CollectionItemType Extensible Enumeration. More...

Classes

struct  Comparator
 Structure provided for use with std::map. More...
 

Functions

void GetNumberOfCollectionItemTypes (int *const numberOfCollectionItemTypes)
 Get the number of standard CollectionItemType's defined by the KIM API. More...
 
int GetCollectionItemType (int const index, CollectionItemType *const collectionItemType)
 Get the identity of each defined standard CollectionItemType. More...
 

Variables

CollectionItemType const modelDriver
 The standard modelDriver CollectionItemType. More...
 
CollectionItemType const portableModel
 The standard portableModel CollectionItemType. More...
 
CollectionItemType const simulatorModel
 The standard simulatorModel CollectionItemType. More...
 

Detailed Description

Contains the enumeration constants and the discovery routines for the CollectionItemType Extensible Enumeration.

Function Documentation

◆ GetCollectionItemType()

int KIM::COLLECTION_ITEM_TYPE::GetCollectionItemType ( int const  index,
CollectionItemType *const  collectionItemType 
)

Get the identity of each defined standard CollectionItemType.

Parameters
[in]indexZero-based index uniquely labeling each defined standard CollectionItemType. This index ordering is only guaranteed to be stable during the lifetime of the current process.
[out]collectionItemTypeThe CollectionItemType object associated with index.
Returns
true if index < 0 or index >= numberOfCollectionItemTypes.
false otherwise.
See also
KIM_COLLECTION_ITEM_TYPE_GetCollectionItemType, kim_collection_item_type_module::kim_get_collection_item_type
Since
2.1

◆ GetNumberOfCollectionItemTypes()

void KIM::COLLECTION_ITEM_TYPE::GetNumberOfCollectionItemTypes ( int *const  numberOfCollectionItemTypes)

Get the number of standard CollectionItemType's defined by the KIM API.

Parameters
[out]numberOfCollectionItemTypesThe number of standard CollectionItemType's defined by the KIM API.
See also
KIM_COLLECTION_ITEM_TYPE_GetNumberOfCollectionItemTypes, kim_collection_item_type_module::kim_get_number_of_collection_item_types
Since
2.1

Variable Documentation

◆ modelDriver

CollectionItemType const KIM::COLLECTION_ITEM_TYPE::modelDriver

◆ portableModel

CollectionItemType const KIM::COLLECTION_ITEM_TYPE::portableModel

◆ simulatorModel

CollectionItemType const KIM::COLLECTION_ITEM_TYPE::simulatorModel