KIM API V2
KIM_LengthUnit.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_LENGTH_UNIT_HPP_
35 #define KIM_LENGTH_UNIT_HPP_
36 
37 #include <string>
38 
39 namespace KIM
40 {
41 
43 {
44  public:
46 
47  LengthUnit();
48  LengthUnit(int const id);
49  LengthUnit(std::string const & str);
50  bool operator==(LengthUnit const & rhs) const;
51  bool operator!=(LengthUnit const & rhs) const;
52  std::string const & String() const;
53 };
54 
55 namespace LENGTH_UNIT
56 {
57 extern LengthUnit const unused;
58 extern LengthUnit const A;
59 extern LengthUnit const Bohr;
60 extern LengthUnit const cm;
61 extern LengthUnit const m;
62 extern LengthUnit const nm;
63 
64 void GetNumberOfLengthUnits(int * const numberOfLengthUnits);
65 int GetLengthUnit(int const index, LengthUnit * const lengthUnit);
66 
67 struct Comparator
68 {
69  bool operator()(LengthUnit const & a, LengthUnit const & b) const
70  {
71  return a.lengthUnitID < b.lengthUnitID;
72  }
73 };
74 } // namespace LENGTH_UNIT
75 } // namespace KIM
76 #endif // KIM_LENGTH_UNIT_HPP_
int GetLengthUnit(int const index, LengthUnit *const lengthUnit)
void GetNumberOfLengthUnits(int *const numberOfLengthUnits)
bool operator==(LengthUnit const &rhs) const
LengthUnit const nm
LengthUnit const unused
LengthUnit const Bohr
bool operator!=(LengthUnit const &rhs) const
LengthUnit const m
LengthUnit const A
std::string const & String() const
bool operator()(LengthUnit const &a, LengthUnit const &b) const
LengthUnit const cm