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_SupportStatus.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_SUPPORT_STATUS_H_
37 #define KIM_SUPPORT_STATUS_H_
38 
47 {
57 };
58 #ifndef KIM_SUPPORT_STATUS_DEFINED_
59 #define KIM_SUPPORT_STATUS_DEFINED_
60 
66 #endif
67 
76 KIM_SupportStatus KIM_SupportStatus_FromString(char const * const str);
77 
85 int KIM_SupportStatus_Known(KIM_SupportStatus const supportStatus);
86 
96  KIM_SupportStatus const rhs);
97 
107  KIM_SupportStatus const rhs);
108 
116 char const * KIM_SupportStatus_ToString(KIM_SupportStatus const supportStatus);
117 
127 
137 
147 
157 
167  int * const numberOfSupportStatuses);
168 
178  int const index, KIM_SupportStatus * const supportStatus);
179 
180 #endif /* KIM_SUPPORT_STATUS_H_ */
int KIM_SupportStatus_Known(KIM_SupportStatus const supportStatus)
Determines if the object is a quantity known to the KIM API.
KIM_SupportStatus const KIM_SUPPORT_STATUS_optional
The standard optional status.
KIM_SupportStatus const KIM_SUPPORT_STATUS_notSupported
The standard notSupported status.
int supportStatusID
Integer identifying the specific SupportStatus represented.
int KIM_SupportStatus_NotEqual(KIM_SupportStatus const lhs, KIM_SupportStatus const rhs)
Compares SupportStatus objects for inequality.
KIM_SupportStatus KIM_SupportStatus_FromString(char const *const str)
Create a SupportStatus object corresponding to the provided string. If the string does not match one ...
An Extensible Enumeration for the SupportStatus's supported by the KIM API.
void KIM_SUPPORT_STATUS_GetNumberOfSupportStatuses(int *const numberOfSupportStatuses)
Get the number of standard SupportStatus's defined by the KIM API.
char const * KIM_SupportStatus_ToString(KIM_SupportStatus const supportStatus)
Converts the object to a string.
KIM_SupportStatus const KIM_SUPPORT_STATUS_requiredByAPI
The standard requiredByAPI status.
int KIM_SUPPORT_STATUS_GetSupportStatus(int const index, KIM_SupportStatus *const supportStatus)
Get the identity of each defined standard SupportStatus.
KIM_SupportStatus const KIM_SUPPORT_STATUS_required
The standard required status.
int KIM_SupportStatus_Equal(KIM_SupportStatus const lhs, KIM_SupportStatus const rhs)
Compares SupportStatus objects for equality.