Gazebo Math

API Reference

7.5.1
gz/math/Stopwatch.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 
18 #ifndef GZ_MATH_STOPWATCH_HH_
19 #define GZ_MATH_STOPWATCH_HH_
20 
21 #include <chrono>
22 #include <gz/math/Export.hh>
23 #include <gz/math/config.hh>
24 #include <gz/utils/ImplPtr.hh>
25 
26 namespace gz::math
27 {
28  // Use a steady clock
30 
31  // Inline bracket to help doxygen filtering.
32  inline namespace GZ_MATH_VERSION_NAMESPACE {
54  class GZ_MATH_VISIBLE Stopwatch
55  {
57  public: Stopwatch();
58 
63  public: bool Start(const bool _reset = false);
64 
69  public: clock::time_point StartTime() const;
70 
74  public: bool Stop();
75 
80  public: clock::time_point StopTime() const;
81 
84  public: bool Running() const;
85 
88  public: void Reset();
89 
95  public: clock::duration ElapsedRunTime() const;
96 
102  public: clock::duration ElapsedStopTime() const;
103 
107  public: bool operator==(const Stopwatch &_watch) const;
108 
112  public: bool operator!=(const Stopwatch &_watch) const;
113 
115  GZ_UTILS_IMPL_PTR(dataPtr)
116  };
117  } // namespace GZ_MATH_VERSION_NAMESPACE
118 } // namespace gz::math
119 #endif // GZ_MATH_STOPWATCH_HH_