File: base.hpp

package info (click to toggle)
sight 25.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 43,252 kB
  • sloc: cpp: 310,629; xml: 17,622; ansic: 9,960; python: 1,379; sh: 144; makefile: 33
file content (94 lines) | stat: -rw-r--r-- 2,750 bytes parent folder | download
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
/************************************************************************
 *
 * 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 <sight/data/config.hpp>

#include "data/validator/base.hpp"
#include "data/validator/factory/new.hpp"
#include "data/validator/registry/detail.hpp"
#include "data/vector.hpp"

#include <core/base.hpp>

namespace sight::data
{

class object;

} // namespace sight::data

namespace sight::data::validator
{

using return_t = std::pair<bool, std::string>;

/**
 * @brief Base class for all data validator's classes.
 */
class SIGHT_DATA_CLASS_API base : public core::base_object
{
public:

    using auto_connect_signals_t = std::vector<sight::core::com::signals::key_t>;

    /**
     * @brief Class used to register a class factory in the validator registry.
     * This class defines also the object factory ( 'create' )
     *
     * @tparam T factory product type
     */
    template<typename T>
    class registry
    {
    public:

        registry(std::string _functor_key)
        {
            sight::data::validator::registry::get()->add_factory(
                _functor_key,
                &sight::data::validator::factory::make<T>
            );
        }
    };
    SIGHT_DECLARE_CLASS(base, core::base_object);

    /**
     * @brief Performs the validation of the given data.
     * @note  This data could be a single data, or a Vector or a Map of one type of data.
     */
    SIGHT_DATA_API virtual return_t validate(const CSPTR(data::object)& _current_data) const = 0;

    /**
     * @brief Allows to specify the signals that require a new validation. Default to sight::data::object::MODIFIED_SIG.
     */
    SIGHT_DATA_API virtual auto_connect_signals_t auto_connect_signals() const;
};

//------------------------------------------------------------------------------

inline base::auto_connect_signals_t base::auto_connect_signals() const
{
    return {sight::data::object::MODIFIED_SIG};
}

} // namespace sight::data::validator