kim-api  2.1.4-git+v2.1.3-git-3-g4c859c7f.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Classes | Typedefs | Functions | Variables
KIM_Collection.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_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 Documentation

◆ KIM_Collection

Convenience typedef.

Since
2.1

Definition at line 65 of file KIM_Collection.h.

Function Documentation

◆ KIM_Collection_Equal()

int KIM_Collection_Equal ( KIM_Collection const  lhs,
KIM_Collection const  rhs 
)

Compares Collection objects for equality.

See also
KIM::Collection::operator==(), kim_collection_module::operator(.eq.)
Since
2.1

◆ KIM_Collection_FromString()

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.

See also
KIM::Collection::Collection(std::string const &), kim_collection_module::kim_from_string
Since
2.1

◆ KIM_COLLECTION_GetCollection()

int KIM_COLLECTION_GetCollection ( int const  index,
KIM_Collection *const  collection 
)

Get the identity of each defined standard Collection.

See also
KIM::COLLECTION::GetCollection, kim_collection_module::kim_get_collection
Since
2.1

◆ KIM_COLLECTION_GetNumberOfCollections()

void KIM_COLLECTION_GetNumberOfCollections ( int *const  numberOfCollections)

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

See also
KIM::COLLECTION::GetNumberOfCollections, kim_collection_module::kim_get_number_of_collections
Since
2.1

◆ KIM_Collection_Known()

int KIM_Collection_Known ( KIM_Collection const  collection)

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

See also
KIM::Collection::Known, kim_collection_module::kim_known
Since
2.1

◆ KIM_Collection_NotEqual()

int KIM_Collection_NotEqual ( KIM_Collection const  lhs,
KIM_Collection const  rhs 
)

Compares Collection objects for inequality.

See also
KIM::Collection::operator!=(), kim_collection_module::operator(.ne.)
Since
2.1

◆ KIM_Collection_ToString()

char const* KIM_Collection_ToString ( KIM_Collection const  collection)

Converts the object to a string.

See also
KIM::Collection::ToString, kim_collection_module::kim_to_string
Since
2.1

Variable Documentation

◆ KIM_COLLECTION_currentWorkingDirectory

KIM_Collection const KIM_COLLECTION_currentWorkingDirectory

The standard currentWorkingDirectory Collection.

See also
KIM::COLLECTION::currentWorkingDirectory, kim_collection_module::kim_collection_current_working_directory
Since
2.1

◆ KIM_COLLECTION_environmentVariable

KIM_Collection const KIM_COLLECTION_environmentVariable

The standard environmentVariable Collection.

See also
KIM::COLLECTION::environmentVariable, kim_collection_module::kim_collection_environment_variable
Since
2.1

◆ KIM_COLLECTION_system

KIM_Collection const KIM_COLLECTION_system

The standard system Collection.

See also
KIM::COLLECTION::system, kim_collection_module::kim_collection_system
Since
2.1

◆ KIM_COLLECTION_user

KIM_Collection const KIM_COLLECTION_user

The standard user Collection.

See also
KIM::COLLECTION::user, kim_collection_module::kim_collection_user
Since
2.1