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.hpp
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_HPP_
32#define KIM_SUPPORT_STATUS_HPP_
33
34#include <string>
35
36namespace KIM
37{
47{
48 public:
59
64
70 SupportStatus(int const id);
71
80 SupportStatus(std::string const & str);
81
90 bool Known() const;
91
99 bool operator==(SupportStatus const & rhs) const;
100
108 bool operator!=(SupportStatus const & rhs) const;
109
120 std::string const & ToString() const;
121}; // class SupportStatus
122
125namespace SUPPORT_STATUS
126{
135extern SupportStatus const requiredByAPI;
136
145extern SupportStatus const notSupported;
146
155extern SupportStatus const required;
156
165extern SupportStatus const optional;
166
167
178void GetNumberOfSupportStatuses(int * const numberOfSupportStatuses);
179
194int GetSupportStatus(int const index, SupportStatus * const supportStatus);
195
200{
205 bool operator()(SupportStatus const & a, SupportStatus const & b) const
206 {
207 return a.supportStatusID < b.supportStatusID;
208 }
209}; // struct Comparator
210} // namespace SUPPORT_STATUS
211} // namespace KIM
212
213#endif // KIM_SUPPORT_STATUS_HPP_
An Extensible Enumeration for the SupportStatus's supported by the KIM API.
SupportStatus(std::string const &str)
Create a SupportStatus object corresponding to the provided string. If the string does not match one ...
bool operator==(SupportStatus const &rhs) const
Compares SupportStatus objects for equality.
std::string const & ToString() const
Converts the object to a string.
bool operator!=(SupportStatus const &rhs) const
Compares SupportStatus objects for inequality.
bool Known() const
Determines if the object is a quantity known to the KIM API.
SupportStatus()
Create an uninitialized SupportStatus object.
int supportStatusID
Integer identifying the specific SupportStatus represented.
SupportStatus(int const id)
Create a SupportStatus object with the specified id.
int GetSupportStatus(int const index, SupportStatus *const supportStatus)
Get the identity of each defined standard SupportStatus.
SupportStatus const notSupported
The standard notSupported status.
SupportStatus const requiredByAPI
The standard requiredByAPI status.
SupportStatus const required
The standard required status.
SupportStatus const optional
The standard optional status.
void GetNumberOfSupportStatuses(int *const numberOfSupportStatuses)
Get the number of standard SupportStatus's defined by the KIM API.
Structure provided for use with std::map.
bool operator()(SupportStatus const &a, SupportStatus const &b) const
Provides an (logically unmeaningful) ordering for SupportStatus objects so that they can be stored in...