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
|
/************************************************************************
*
* Copyright (C) 2025 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 <data/object.hpp>
#include <data/validator/base.hpp>
#include <service/controller.hpp>
namespace sight::module::data
{
/**
* @brief Generic service to validate data object given a specified validator class.
* The validator inherits from sight::data::validator::base and registered with the macro SIGHT_REGISTER_DATA_VALIDATOR.
* The service auto_connects all signals declared by the validator with the function auto_connect_signals() to the
* update slot, triggering a validation check.
*
* @section Signals Signals
* - \b valid() : The object is valid given the specified validator.
* - \b invalid() : The object is invalid given the specified validator.
* - \b is_valid(bool) : The object is valid given the specified validator.
* - \b is_invalid(bool) : The object is invalid given the specified validator.
*
* @section XML XML Configuration
*
* @code{.xml}
<service uid="..." type="sight::module::data::validate" >
<in key="data" uid="..."/>
<config id="..." />
</service>
@endcode
* @subsection Input Input
* - \b data [sight::data::object]: data object to validate.
* @subsection Configuration Configuration
* - \b id (string): class identifier of the validator
*/
class validate final : public service::controller
{
public:
SIGHT_DECLARE_SERVICE(validate, service::controller);
struct signals
{
using void_t = sight::core::com::signal<void ()>;
using bool_t = sight::core::com::signal<void (bool)>;
inline static const sight::core::com::signals::key_t VALID = "valid";
inline static const sight::core::com::signals::key_t INVALID = "invalid";
inline static const sight::core::com::signals::key_t IS_VALID = "is_valid";
inline static const sight::core::com::signals::key_t IS_INVALID = "is_invalid";
};
/// Constructor
validate();
/// Destructor
~validate() final = default;
protected:
/// Configures the service
void configuring(const service::config_t& _config) final;
/// Does nothing
void starting() final;
/// Does nothing
void stopping() final;
/// Extract the object(s)
void updating() final;
/// Updates when object is modified, according to the validator auto_connect_signals() function
service::connections_t auto_connections() const final;
private:
sight::data::validator::base::sptr m_validator;
sight::data::ptr<sight::data::object, sight::data::access::in> m_data {this, "data"};
};
} // namespace sight::module::data
|
