kim-api  2.1.4-git+v2.1.3-git-1-g7847914a.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Classes | Typedefs | Functions | Variables
KIM_CollectionItemType.h File Reference
This graph shows which files directly or indirectly include this file:

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 Documentation

◆ KIM_CollectionItemType

Convenience typedef.

Since
2.1

Definition at line 66 of file KIM_CollectionItemType.h.

Function Documentation

◆ KIM_COLLECTION_ITEM_TYPE_GetCollectionItemType()

int KIM_COLLECTION_ITEM_TYPE_GetCollectionItemType ( int const  index,
KIM_CollectionItemType *const  collectionItemType 
)

Get the identity of each defined standard CollectionItemType.

See also
KIM::COLLECTION_ITEM_TYPE::GetCollectionItemType, kim_collection_item_type_module::kim_get_collection_item_type
Since
2.1

◆ KIM_COLLECTION_ITEM_TYPE_GetNumberOfCollectionItemTypes()

void KIM_COLLECTION_ITEM_TYPE_GetNumberOfCollectionItemTypes ( int *const  numberOfCollectionItemTypes)

Get the 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

◆ KIM_CollectionItemType_Equal()

int KIM_CollectionItemType_Equal ( KIM_CollectionItemType const  lhs,
KIM_CollectionItemType const  rhs 
)

Compares CollectionItemType objects for equality.

See also
KIM::CollectionItemType::operator==(), kim_collection_item_type_module::operator(.eq.)
Since
2.1

◆ KIM_CollectionItemType_FromString()

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.

See also
KIM::CollectionItemType::CollectionItemType(std::string const &), kim_collection_item_type_module::kim_from_string
Since
2.1

◆ KIM_CollectionItemType_Known()

int KIM_CollectionItemType_Known ( KIM_CollectionItemType const  collectionItemType)

Determines if the object is a quantity known to the KIM API.

See also
KIM::CollectionItemType::Known, kim_collection_item_type_module::kim_known
Since
2.1

◆ KIM_CollectionItemType_NotEqual()

int KIM_CollectionItemType_NotEqual ( KIM_CollectionItemType const  lhs,
KIM_CollectionItemType const  rhs 
)

Compares CollectionItemType objects for inequality.

See also
KIM::CollectionItemType::operator!=(), kim_collection_item_type_module::operator(.ne.)
Since
2.1

◆ KIM_CollectionItemType_ToString()

char const* KIM_CollectionItemType_ToString ( KIM_CollectionItemType const  collectionItemType)

Converts the object to a string.

See also
KIM::CollectionItemType::ToString, kim_collection_item_type_module::kim_to_string
Since
2.1

Variable Documentation

◆ KIM_COLLECTION_ITEM_TYPE_modelDriver

KIM_CollectionItemType const KIM_COLLECTION_ITEM_TYPE_modelDriver

◆ KIM_COLLECTION_ITEM_TYPE_portableModel

KIM_CollectionItemType const KIM_COLLECTION_ITEM_TYPE_portableModel

◆ KIM_COLLECTION_ITEM_TYPE_simulatorModel

KIM_CollectionItemType const KIM_COLLECTION_ITEM_TYPE_simulatorModel