1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/*
* Copyright (C) 2016 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef IGNITION_COMMON_TIMER_HH_
#define IGNITION_COMMON_TIMER_HH_
#include <ignition/common/Time.hh>
#include <ignition/common/Export.hh>
namespace ignition
{
namespace common
{
/// \class Timer Timer.hh common/common.hh
/// \brief A timer class, used to time things in real world walltime
class IGNITION_COMMON_VISIBLE Timer
{
/// \brief Constructor
public: Timer();
/// \brief Destructor
public: virtual ~Timer();
/// \brief Start the timer
public: virtual void Start();
/// \brief Stop the timer
public: virtual void Stop();
/// \brief Returns true if the timer is running.
/// \return Tue if the timer has been started and not stopped.
public: bool Running() const;
/// \brief Get the elapsed time
/// \return The time
public: Time IGN_DEPRECATED(4) Elapsed() const;
/// \brief Get the elapsed time
/// \return The elapsed time
public: std::chrono::duration<double> ElapsedTime() const;
/// \brief Stream operator friendly
public: friend std::ostream &operator<<(std::ostream &out,
const ignition::common::Timer &t)
{
out << t.ElapsedTime().count();
return out;
}
IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
/// \brief The time of the last call to Start
private: std::chrono::steady_clock::time_point start;
/// \brief The time when Stop was called.
private: std::chrono::steady_clock::time_point stop;
IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
/// \brief True if the timer is running.
private: bool running;
};
}
}
#endif
|
