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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/************************************************************************
*
* 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 <data/object.hpp>
#include <service/controller.hpp>
namespace sight::module::data
{
/**
* This service manages a contained object (add/swap/remove) into a container object (Map, Vector, series_set).
*
* It works on different objects:
* - data::map: the object is added/swapped/removed from map at the given key
* - data::vector: the object is added or removed from the container
* - data::series_set: the object is added or removed from the container
* - data::object: the object is added or removed from the field map at the given key
* activity
* @section Slots Slots
* - \b failed(): Sent on failure.
*
* @section Slots Slots
* - \b add() : Adds the object into the target (Vector, series_set, Map), if target is a Map or a field, it
* is added at the key given by config.
* - \b add_copy() : Adds a copy of the object into the target (Vector, series_set, Map), if target is a Map
* or a field, it is added at the key given by config.
* - \b add_or_swap() : Adds the object if it is not present in the target, else if target is a map or a field,
* the
* object is swapped.
* - \b pop_front() : Extracts the first object of the collection and removes it.
* - \b remove() : Removes the object.
* - \b remove_if_present() : Removes the object if it is present.
* - \b swap_obj() : Only if target is a Map or a field : swaps the object into the map with the key given by
* config.
* - \b clear() : Removes all objects.
*
* @section XML XML Configuration
*
* For data::map:
* @code{.xml}
<service type="sight::module::data::manage">
<inout key="object" uid="..." />
<inout key="container" uid="..." />
<mapKey>...</mapKey>
</service>
@endcode
*
* For data::vector:
* @code{.xml}
<service type="sight::module::data::manage">
<inout key="object" uid="..." />
<inout key="container" uid="..." />
</service>
@endcode
*
* For data::series_set:
* @code{.xml}
<service type="sight::module::data::manage">
<inout key="object" uid="..." />
<inout key="container" uid="..." />
</service>
@endcode
*
* For data::object:
* @code{.xml}
<service type="sight::module::data::manage">
<inout key="object" uid="..." />
<inout key="container" uid="..." />
<field>...</field>
</service>
@endcode
*
* @subsection In-Out In-Out
* - \b object [sight::data::object] (optional): object to add/swap/remove. Not needed when invoking clean slot and
* remove
* slots with maps and fields, since the removal is based on the name.
* - \b container [sight::data::object]: Map/Vector/Series where to add/swap/remove object, or where
* to add/swap/remove object as a field.
*
* @subsection Configuration Configuration
* - \b mapKey (optional, only used if the target object in a Map) : key of the object in the map
* - \b field (optional) : name of the field
*/
class manage final : public service::controller
{
public:
SIGHT_DECLARE_SERVICE(manage, sight::service::controller);
/// Constructor. Do nothing.
manage() noexcept;
/// Destructor. Do nothing.
~manage() noexcept final = default;
struct signals
{
static inline const signal_key_t FAILED = "failed";
using empty_t = core::com::signal<void (void)>;
};
struct slots
{
static const inline slot_key_t ADD = "add";
static const inline slot_key_t ADD_COPY = "add_copy";
static const inline slot_key_t ADD_OR_SWAP = "add_or_swap";
static const inline slot_key_t SWAP_OBJ = "swap_obj";
static const inline slot_key_t POP_FRONT = "pop_front";
static const inline slot_key_t REMOVE = "remove";
static const inline slot_key_t REMOVE_IF_PRESENT = "remove_if_present";
static const inline slot_key_t CLEAR = "clear";
};
protected:
/// Configures the service.
void configuring() final;
/// Implements starting method derived from base. Do nothing.
void starting() final;
/// Implements stopping method derived from base. Do nothing.
void stopping() final;
/// Implements updating method derived from base. Do nothing.
void updating() final;
/**
* @name Slots
* @{
*/
/// Adds the object into the map with the key given by config.
void add();
/// Adds a copy of object into the map with the key given by config.
void add_copy();
/**
* @brief Adds or swap the object into the map with the key given by config.
*
* Adds the object if it is not present in the map, else swaps it.
*/
void add_or_swap();
/// Swaps the object into the map with the key given by config.
void swap();
/// Swaps the object into the map with the key given by config.
void pop_front();
/// Removes the object from the map at the key given by config.
void remove();
/// Removes the object from the map at the key given by config if it is present.
void remove_if_present();
/// Removes all objects.
void clear();
/**
* @}
*/
private:
void internal_add(bool _copy);
std::string m_object_uid; ///< uid of the object
std::string m_map_key; ///< key of the object to manage in the map
std::string m_field_name; ///< name of the field to manage in the object
sight::data::ptr<sight::data::object, sight::data::access::inout> m_object {this, "object", true};
sight::data::ptr<sight::data::object, sight::data::access::inout> m_container {this, "container"};
};
} // namespace sight::module::data
|
