KIM API V2
KIM_Numbering.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-beta.0 package.
31 //
32 
33 
34 #ifndef KIM_NUMBERING_HPP_
35 #define KIM_NUMBERING_HPP_
36 
37 #include <string>
38 
39 namespace KIM
40 {
41 
42 class Numbering
43 {
44  public:
46 
47  Numbering();
48  Numbering(int const id);
49  Numbering(std::string const & str);
50  bool operator==(Numbering const & rhs) const;
51  bool operator!=(Numbering const & rhs) const;
52  std::string const & String() const;
53 };
54 
55 namespace NUMBERING
56 {
57 extern Numbering const zeroBased;
58 extern Numbering const oneBased;
59 
60 void GetNumberOfNumberings(int * const numberOfNumberings);
61 int GetNumbering(int const index, Numbering * const numbering);
62 
63 struct Comparator
64 {
65  bool operator()(Numbering const & a, Numbering const & b) const
66  {
67  return a.numberingID < b.numberingID;
68  }
69 };
70 } // namespace NUMBERING
71 } // namespace KIM
72 #endif // KIM_NUMBERING_HPP_
Numbering const oneBased
bool operator()(Numbering const &a, Numbering const &b) const
std::string const & String() const
void GetNumberOfNumberings(int *const numberOfNumberings)
int GetNumbering(int const index, Numbering *const numbering)
bool operator==(Numbering const &rhs) const
Numbering const zeroBased
bool operator!=(Numbering const &rhs) const