kim-api 2.3.0+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Loading...
Searching...
No Matches
KIM_SupportStatus.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-2.3.0 package. */
28/* */
29
30
31#ifndef KIM_SUPPORT_STATUS_H_
32#define KIM_SUPPORT_STATUS_H_
33
42{
52};
53#ifndef KIM_SUPPORT_STATUS_DEFINED_
54#define KIM_SUPPORT_STATUS_DEFINED_
61#endif
62
72
81
91 KIM_SupportStatus const rhs);
92
102 KIM_SupportStatus const rhs);
103
111char const * KIM_SupportStatus_ToString(KIM_SupportStatus const supportStatus);
112
122
132
142
152
162 int * const numberOfSupportStatuses);
163
173 int const index, KIM_SupportStatus * const supportStatus);
174
175#endif /* KIM_SUPPORT_STATUS_H_ */
int KIM_SupportStatus_Equal(KIM_SupportStatus const lhs, KIM_SupportStatus const rhs)
Compares SupportStatus objects for equality.
int KIM_SupportStatus_NotEqual(KIM_SupportStatus const lhs, KIM_SupportStatus const rhs)
Compares SupportStatus objects for inequality.
KIM_SupportStatus const KIM_SUPPORT_STATUS_requiredByAPI
The standard requiredByAPI status.
KIM_SupportStatus const KIM_SUPPORT_STATUS_notSupported
The standard notSupported status.
KIM_SupportStatus const KIM_SUPPORT_STATUS_optional
The standard optional status.
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 ...
KIM_SupportStatus const KIM_SUPPORT_STATUS_required
The standard required status.
void KIM_SUPPORT_STATUS_GetNumberOfSupportStatuses(int *const numberOfSupportStatuses)
Get the number of standard SupportStatus's defined by the KIM API.
int KIM_SupportStatus_Known(KIM_SupportStatus const supportStatus)
Determines if the object is a quantity known to the KIM API.
char const * KIM_SupportStatus_ToString(KIM_SupportStatus const supportStatus)
Converts the object to a string.
int KIM_SUPPORT_STATUS_GetSupportStatus(int const index, KIM_SupportStatus *const supportStatus)
Get the identity of each defined standard SupportStatus.
An Extensible Enumeration for the SupportStatus's supported by the KIM API.
int supportStatusID
Integer identifying the specific SupportStatus represented.