Gazebo Math

API Reference

7.4.0
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
26namespace gz
27{
28 namespace math
29 {
30 // Use a steady clock
32
33 // Inline bracket to help doxygen filtering.
34 inline namespace GZ_MATH_VERSION_NAMESPACE {
56 class GZ_MATH_VISIBLE Stopwatch
57 {
59 public: Stopwatch();
60
65 public: bool Start(const bool _reset = false);
66
71 public: clock::time_point StartTime() const;
72
76 public: bool Stop();
77
82 public: clock::time_point StopTime() const;
83
86 public: bool Running() const;
87
90 public: void Reset();
91
97 public: clock::duration ElapsedRunTime() const;
98
104 public: clock::duration ElapsedStopTime() const;
105
109 public: bool operator==(const Stopwatch &_watch) const;
110
114 public: bool operator!=(const Stopwatch &_watch) const;
115
117 GZ_UTILS_IMPL_PTR(dataPtr)
118 };
119 }
120 }
121}
122#endif