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
|
/************************************************************************
*
* Copyright (C) 2009-2024 IRCAD France
* Copyright (C) 2012-2017 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/thread/worker.hpp"
#include <core/mt/types.hpp>
#include <functional>
namespace sight::core::thread
{
/**
* @brief The Timer class provides single-shot or repetitive timers.
* A Timer triggers a function once after a delay, or periodically, inside the
* worker loop. The delay or the period is defined by the duration attribute.
*
* Timer's function must be set before starting the timer.
*/
class SIGHT_CORE_CLASS_API timer : public core::base_object
{
public:
/**
* @name Typedefs
* @{ */
using sptr = std::shared_ptr<timer>;
using function_type = std::function<void ()>;
using time_duration_t = std::chrono::duration<double>;
/** @} */
SIGHT_CORE_API ~timer() override = default;
/// Starts or restarts the timer.
SIGHT_CORE_API virtual void start() = 0;
/// Stops the timer and cancel all pending operations.
SIGHT_CORE_API virtual void stop()
{
}
/// Sets time duration.
SIGHT_CORE_API virtual void set_duration(time_duration_t _duration) = 0;
/// Sets the function to be triggered when time duration expires.
template<typename F>
void set_function(F _f)
{
core::mt::scoped_lock lock(m_mutex);
m_function = _f;
updated_function();
}
/// Returns if the timer mode is 'one shot'.
virtual bool is_one_shot() const = 0;
/// Sets timer mode.
virtual void set_one_shot(bool _one_shot) = 0;
/// Returns true if the timer is currently running.
virtual bool is_running() const = 0;
protected:
/**
* @brief Constructs a Timer.
* By default, a the Timer mode is repetitive.
*/
SIGHT_CORE_API timer() = default;
/// Copy constructor forbidden.
timer(const timer&);
/// Copy operator forbidden.
timer& operator=(const timer&);
/// This method is triggered when Timer's function is changed.
SIGHT_CORE_API virtual void updated_function()
{
}
friend struct timer_callback;
/// Function object to execute each time the timer expires.
function_type m_function;
mutable core::mt::mutex m_mutex;
};
} //namespace sight::core::thread
|
