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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/************************************************************************
*
* Copyright (C) 2009-2025 IRCAD France
* Copyright (C) 2012-2019 IHU Strasbourg
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Sight is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
#pragma once
#include <sight/core/config.hpp>
#include "core/base_object.hpp"
#include "core/clock.hpp"
namespace sight::core
{
/**
* @brief This class provide a timer (stopwatch).
* Timer is able to measure the elapsed time with a few micro-seconds.
* accuracy, on Linux, Mac OS and Windows
*/
class SIGHT_CORE_CLASS_API timer
{
public:
using sptr = std::shared_ptr<timer>;
/**
* @name Constructor/Destructor
* @{ */
SIGHT_CORE_API timer();
/** @} */
/**
* @brief Start the timer.
*/
SIGHT_CORE_API void start();
/**
* @brief Stop the timer.
* stop() will not reset the timer.
*/
SIGHT_CORE_API void stop();
/**
* @brief Reset the timer and leave it in the same state it was (started or stopped).
*
* @param _initial_value Initial value in microseconds from which the timer
* will start to count.
*/
SIGHT_CORE_API void reset(clock::type _initial_value = 0.);
/**
* @name Elapsed time
* @brief These methods return the cumulated elapsed running time of the timer
* the timer is running when start() has been invoked and stop running on
* stop() or reset() calls.
* @{ */
/**
* @return Elapsed time in seconds
*/
SIGHT_CORE_API core::clock::type get_elapsed_time_in_sec() const;
/**
* @return Elapsed time in milliseconds
*/
SIGHT_CORE_API core::clock::type get_elapsed_time_in_milli_sec() const;
/**
* @return Elapsed time in microseconds
*/
SIGHT_CORE_API core::clock::type get_elapsed_time_in_micro_sec() const;
/** @} */
private:
/**
* @brief Last start time.
*/
core::clock::type m_start_time_in_micro_sec {};
/**
* @brief Last "break" time.
*/
core::clock::type m_end_time_in_micro_sec {};
/**
* @brief accumulated running time.
*/
core::clock::type m_cumul_time_in_micro_sec {};
/**
* @brief timer status.
*/
bool m_stopped {true};
};
} //namespace sight::core
|
