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).
KIM_CollectionItemType.h
Go to the documentation of this file.
1 /* */
2 /* CDDL HEADER START */
3 /* */
4 /* The contents of this file are subject to the terms of the Common */
5 /* Development and Distribution License Version 1.0 (the "License"). */
6 /* */
7 /* You can obtain a copy of the license at */
8 /* http://www.opensource.org/licenses/CDDL-1.0. See the License for the */
9 /* specific language governing permissions and limitations under the License. */
10 /* */
11 /* When distributing Covered Code, include this CDDL HEADER in each file and */
12 /* include the License file in a prominent location with the name */
13 /* LICENSE.CDDL. */
14 /* If applicable, add the following below this CDDL HEADER, with the fields */
15 /* enclosed by brackets "[]" replaced with your own identifying information: */
16 /* */
17 /* Portions Copyright (c) [yyyy] [name of copyright owner]. */
18 /* All rights reserved. */
19 /* */
20 /* CDDL HEADER END */
21 /* */
22 
23 /* */
24 /* Copyright (c) 2016--2019, Regents of the University of Minnesota. */
25 /* All rights reserved. */
26 /* */
27 /* Contributors: */
28 /* Ryan S. Elliott */
29 /* */
30 
31 /* */
32 /* Release: This file is part of the kim-api.git repository. */
33 /* */
34 
35 
36 #ifndef KIM_COLLECTION_ITEM_TYPE_H_
37 #define KIM_COLLECTION_ITEM_TYPE_H_
38 
48 {
58 };
59 #ifndef KIM_COLLECTION_ITEM_TYPE_DEFINED_
60 #define KIM_COLLECTION_ITEM_TYPE_DEFINED_
61 
67 #endif
68 
79 KIM_CollectionItemType_FromString(char const * const str);
80 
90  KIM_CollectionItemType const collectionItemType);
91 
101  KIM_CollectionItemType const rhs);
102 
112  KIM_CollectionItemType const rhs);
113 
123  KIM_CollectionItemType const collectionItemType);
124 
134 
144 
154 
164  int * const numberOfCollectionItemTypes);
165 
175  int const index, KIM_CollectionItemType * const collectionItemType);
176 
177 #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.