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_Collection.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_H_
37 #define KIM_COLLECTION_H_
38 
47 {
57 };
58 #ifndef KIM_COLLECTION_DEFINED_
59 #define KIM_COLLECTION_DEFINED_
60 
66 #endif
67 
76 KIM_Collection KIM_Collection_FromString(char const * const str);
77 
85 int KIM_Collection_Known(KIM_Collection const collection);
86 
94 int KIM_Collection_Equal(KIM_Collection const lhs, KIM_Collection const rhs);
95 
103 int KIM_Collection_NotEqual(KIM_Collection const lhs, KIM_Collection const rhs);
104 
112 char const * KIM_Collection_ToString(KIM_Collection const collection);
113 
123 
133 
143 
153 
162 void KIM_COLLECTION_GetNumberOfCollections(int * const numberOfCollections);
163 
172 int KIM_COLLECTION_GetCollection(int const index,
173  KIM_Collection * const collection);
174 
175 #endif /* KIM_COLLECTION_H_ */
KIM_Collection const KIM_COLLECTION_environmentVariable
The standard environmentVariable Collection.
KIM_Collection const KIM_COLLECTION_system
The standard system Collection.
KIM_Collection const KIM_COLLECTION_currentWorkingDirectory
The standard currentWorkingDirectory Collection.
void KIM_COLLECTION_GetNumberOfCollections(int *const numberOfCollections)
Get the number of standard Collection's defined by the KIM API.
char const * KIM_Collection_ToString(KIM_Collection const collection)
Converts the object to a string.
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 ...
int KIM_Collection_NotEqual(KIM_Collection const lhs, KIM_Collection const rhs)
Compares Collection objects for inequality.
An Extensible Enumeration for the Collection's supported by the KIM API.
int KIM_COLLECTION_GetCollection(int const index, KIM_Collection *const collection)
Get the identity of each defined standard Collection.
int KIM_Collection_Equal(KIM_Collection const lhs, KIM_Collection const rhs)
Compares Collection objects for equality.
int collectionID
Integer identifying the specific Collection represented.
KIM_Collection const KIM_COLLECTION_user
The standard user Collection.
int KIM_Collection_Known(KIM_Collection const collection)
Determines if the object is a quantity known to the KIM API.