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
|
/************************************************************************
*
* Copyright (C) 2014-2024 IRCAD France
* Copyright (C) 2014-2020 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/ex_timeline/config.hpp>
#include "message_tl.hpp"
#include <service/base.hpp>
/**
* Do not mark `ex_timeline` as incorrect.
* cspell:ignore ex_timeline
*/
namespace sight::core::thread
{
class Timer;
} // namespace sight::core::thread
namespace ex_timeline
{
/**
* @brief Service that consumes messages stored in a timeline. You can either connect the service slot to the timeline
* to display a message each time something is pushed, or you can specify a period in the configuration to
* display a message periodically.
*
* @section Slots Slots
* - \b consume() : read a message from the timeline.
* @section XML XML Configuration
*
* @code{.xml}
<service type="ex_timeline::consumer" >
<in key="timeline" uid="..." />
<id>0</id>
<period>1000</period>
</service>
@endcode
* @subsection Input Input:
* - \b timeline [::ex_timeline::message_tl]: timeline containing messages.
* @subsection Configuration Configuration:
* - \b id : id of the receiver.
* - \b period (optional): time between two messages display, in milliseconds.
*/
class SIGHT_EX_TIMELINE_CLASS_API consumer : public sight::service::base
{
public:
SIGHT_EX_TIMELINE_API static const sight::core::com::slots::key_t CONSUME_SLOT;
SIGHT_DECLARE_SERVICE(consumer, sight::service::base);
SIGHT_EX_TIMELINE_API consumer() noexcept;
SIGHT_EX_TIMELINE_API ~consumer() noexcept override;
protected:
/// Configure the service
void configuring() final;
/// Start the timer if a period is defined.
void starting() final;
/// Stop the timer.
void stopping() final;
/// Called by the timer to consume a message periodically
void updating() final;
/// Called by a signal to consume a message
void consume(sight::core::clock::type _timestamp);
private:
/// Timer used to read messages periodically
SPTR(sight::core::thread::timer) m_timer;
/// Id of the receiver
unsigned int m_receiver_id {};
/// A message will be read every m_uiPeriod milliseconds.
unsigned int m_period {0};
sight::data::ptr<ex_timeline::message_tl, sight::data::access::in> m_timeline {this, "timeline"};
};
} // namespace ex_timeline
|
