KIM API V2
KIM_SupportStatus.hpp
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 Development
5 // 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 LICENSE.CDDL.
13 // If applicable, add the following below this CDDL HEADER, with the fields
14 // enclosed by brackets "[]" replaced with your own identifying information:
15 //
16 // Portions Copyright (c) [yyyy] [name of copyright owner]. All rights reserved.
17 //
18 // CDDL HEADER END
19 //
20 
21 //
22 // Copyright (c) 2016--2018, Regents of the University of Minnesota.
23 // All rights reserved.
24 //
25 // Contributors:
26 // Ryan S. Elliott
27 //
28 
29 //
30 // Release: This file is part of the kim-api-v2.0.0-alpha.0 package.
31 //
32 
33 
34 #ifndef KIM_SUPPORT_STATUS_HPP_
35 #define KIM_SUPPORT_STATUS_HPP_
36 
37 #include <string>
38 
39 namespace KIM
40 {
41 
43 {
44  public:
46 
47  SupportStatus();
48  SupportStatus(int const id);
49  SupportStatus(std::string const & str);
50  bool operator==(SupportStatus const & rhs) const;
51  bool operator!=(SupportStatus const & rhs) const;
52  std::string String() const;
53 };
54 
55 namespace SUPPORT_STATUS
56 {
57 extern SupportStatus const requiredByAPI;
58 extern SupportStatus const notSupported;
59 extern SupportStatus const required;
60 extern SupportStatus const optional;
61 
62 void GetNumberOfSupportStatuses(int * const numberOfSupportStatuses);
63 int GetSupportStatus(int const index, SupportStatus * const supportStatus);
64 
65 struct Comparator
66 {
67  bool operator()(SupportStatus const & a, SupportStatus const & b) const
68  {
69  return a.supportStatusID < b.supportStatusID;
70  }
71 };
72 } // namespace SUPPORT_STATUS
73 } // namespace KIM
74 #endif // KIM_SUPPORT_STATUS_HPP_
void GetNumberOfSupportStatuses(int *const numberOfSupportStatuses)
bool operator==(SupportStatus const &rhs) const
int GetSupportStatus(int const index, SupportStatus *const supportStatus)
bool operator()(SupportStatus const &a, SupportStatus const &b) const
std::string String() const
SupportStatus const notSupported
SupportStatus const required
SupportStatus const requiredByAPI
bool operator!=(SupportStatus const &rhs) const
SupportStatus const optional