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
|
/************************************************************************
*
* Copyright (C) 2024 IRCAD France
*
* 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 "updater.hpp"
namespace sight::app
{
/**
* @brief This service updates all configured elements in a strict sequential order.
* The elements can be a service or another updater (inheriting from sight::app::updater).
*
* @section XML XML Configuration
*
* @code{.xml}
<service uid="..." type="sight::app::update_sequence">
<config loop="true">
<service uid="..." />
<service uid="..." />
<updater uid="..." />
</config>
</service>
@endcode
* @subsection Configuration Configuration
* - \b loop: call the update sequence in loop when the service starts and until it stops.
* - \b parent: uid of the parent updater slot, as specified by the parent service in an <updater> element.
* - \b service: uid of the service
* - \b updater: uid of another updater, identified by a registration id. In this case, the updater
* must use this id in the "parent" attribute.
*/
class SIGHT_APP_CLASS_API update_sequence final : public app::updater
{
public:
SIGHT_DECLARE_SERVICE(update_sequence, sight::app::updater);
/// Destructor
SIGHT_APP_API ~update_sequence() final = default;
private:
/// Does nothing
SIGHT_APP_API void starting() final;
/// Does nothing
SIGHT_APP_API void stopping() final;
/// Does nothing
SIGHT_APP_API void updating() final;
};
} // namespace sight::app
|
