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).
KIM_CollectionItemType.h
Go to the documentation of this file.
1 /* */
2 /* KIM-API: An API for interatomic models */
3 /* Copyright (c) 2013--2022, Regents of the University of Minnesota. */
4 /* All rights reserved. */
5 /* */
6 /* Contributors: */
7 /* Ryan S. Elliott */
8 /* */
9 /* SPDX-License-Identifier: LGPL-2.1-or-later */
10 /* */
11 /* This library is free software; you can redistribute it and/or */
12 /* modify it under the terms of the GNU Lesser General Public */
13 /* License as published by the Free Software Foundation; either */
14 /* version 2.1 of the License, or (at your option) any later version. */
15 /* */
16 /* This library is distributed in the hope that it will be useful, */
17 /* but WITHOUT ANY WARRANTY; without even the implied warranty of */
18 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
19 /* Lesser General Public License for more details. */
20 /* */
21 /* You should have received a copy of the GNU Lesser General Public License */
22 /* along with this library; if not, write to the Free Software Foundation, */
23 /* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */
24 /* */
25 
26 /* */
27 /* Release: This file is part of the kim-api.git repository. */
28 /* */
29 
30 
31 #ifndef KIM_COLLECTION_ITEM_TYPE_H_
32 #define KIM_COLLECTION_ITEM_TYPE_H_
33 
43 {
53 };
54 #ifndef KIM_COLLECTION_ITEM_TYPE_DEFINED_
55 #define KIM_COLLECTION_ITEM_TYPE_DEFINED_
56 
62 #endif
63 
74 KIM_CollectionItemType_FromString(char const * const str);
75 
85  KIM_CollectionItemType const collectionItemType);
86 
96  KIM_CollectionItemType const rhs);
97 
107  KIM_CollectionItemType const rhs);
108 
118  KIM_CollectionItemType const collectionItemType);
119 
129 
139 
149 
159  int * const numberOfCollectionItemTypes);
160 
170  int const index, KIM_CollectionItemType * const collectionItemType);
171 
172 #endif /* KIM_COLLECTION_ITEM_TYPE_H_ */
int KIM_COLLECTION_ITEM_TYPE_GetCollectionItemType(int const index, KIM_CollectionItemType *const collectionItemType)
Get the identity of each defined standard CollectionItemType.
int KIM_CollectionItemType_Equal(KIM_CollectionItemType const lhs, KIM_CollectionItemType const rhs)
Compares CollectionItemType objects for equality.
KIM_CollectionItemType const KIM_COLLECTION_ITEM_TYPE_simulatorModel
The standard simulatorModel CollectionItemType.
KIM_CollectionItemType KIM_CollectionItemType_FromString(char const *const str)
Create a CollectionItemType object corresponding to the provided string. If the string does not match...
KIM_CollectionItemType const KIM_COLLECTION_ITEM_TYPE_portableModel
The standard portableModel CollectionItemType.
char const * KIM_CollectionItemType_ToString(KIM_CollectionItemType const collectionItemType)
Converts the object to a string.
void KIM_COLLECTION_ITEM_TYPE_GetNumberOfCollectionItemTypes(int *const numberOfCollectionItemTypes)
Get the number of standard CollectionItemType's defined by the KIM API.
int KIM_CollectionItemType_NotEqual(KIM_CollectionItemType const lhs, KIM_CollectionItemType const rhs)
Compares CollectionItemType objects for inequality.
int KIM_CollectionItemType_Known(KIM_CollectionItemType const collectionItemType)
Determines if the object is a quantity known to the KIM API.
KIM_CollectionItemType const KIM_COLLECTION_ITEM_TYPE_modelDriver
The standard modelDriver CollectionItemType.
int collectionItemTypeID
Integer identifying the specific CollectionItemType represented.
An Extensible Enumeration for the CollectionItemType's supported by the KIM API.