KIM API V2
KIM_TimeUnit.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.1 package.
31 //
32 
33 
34 #ifndef KIM_TIME_UNIT_HPP_
35 #define KIM_TIME_UNIT_HPP_
36 
37 #include <string>
38 
39 namespace KIM
40 {
41 
42 class TimeUnit
43 {
44  public:
46 
47  TimeUnit();
48  TimeUnit(int const id);
49  TimeUnit(std::string const & str);
50  bool operator==(TimeUnit const & rhs) const;
51  bool operator!=(TimeUnit const & rhs) const;
52  std::string const & String() const;
53 };
54 
55 namespace TIME_UNIT
56 {
57 extern TimeUnit const unused;
58 extern TimeUnit const fs;
59 extern TimeUnit const ps;
60 extern TimeUnit const ns;
61 extern TimeUnit const s;
62 
63 void GetNumberOfTimeUnits(int * const numberOfTimeUnits);
64 int GetTimeUnit(int const index, TimeUnit * const timeUnit);
65 
66 struct Comparator
67 {
68  bool operator()(TimeUnit const & a, TimeUnit const & b) const
69  {
70  return a.timeUnitID < b.timeUnitID;
71  }
72 };
73 } // namespace TIME_UNIT
74 } // namespace KIM
75 #endif // KIM_TIME_UNIT_HPP_
void GetNumberOfTimeUnits(int *const numberOfTimeUnits)
bool operator==(TimeUnit const &rhs) const
TimeUnit const ps
TimeUnit const ns
TimeUnit const s
std::string const & String() const
TimeUnit const fs
bool operator()(TimeUnit const &a, TimeUnit const &b) const
bool operator!=(TimeUnit const &rhs) const
int GetTimeUnit(int const index, TimeUnit *const timeUnit)
TimeUnit const unused