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
|
/************************************************************************
*
* Copyright (C) 2009-2024 IRCAD France
* Copyright (C) 2012-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/core/config.hpp>
#include <memory>
namespace sight::core::runtime
{
class module;
} // namespace sight::core::runtime
namespace sight::core::runtime
{
/**
* @brief Implements the base class for all element managed by a module.
*/
class SIGHT_CORE_CLASS_API module_element
{
public:
virtual ~module_element() = default;
/**
* @brief Retrieves the module that owns the extension.
*
* @return a pointer to a module instance
*/
[[nodiscard]] SIGHT_CORE_API std::shared_ptr<module> get_module() const;
/**
* @brief Tells if the element is enabled or not.
*
* @remark The element will asks its module enable state. if the module
* element is enabled then the program verifies if the module
* element is enabled too.
*
* @pre The module must not be null.
*
* @return true or false
*/
[[nodiscard]] SIGHT_CORE_API bool enabled() const;
/**
* @brief Set if the element is enabled or not.
*
* @see isEnabled
*
* @param[in] _enable To know if module element is enabled
*/
SIGHT_CORE_API void set_enable(bool _enable);
protected:
/**
* @brief Constructor
*
* @remark The instance will try to guess the module that is being loaded and
* consider that module as its owning module
*
* @post The module isn't null.
* @see core::runtime::module::get_loading_module()
*/
SIGHT_CORE_API module_element();
/**
* @brief Constructor
*
* @post The module isn't null.
* @param[in] _module a shared pointer to the managing module
*/
SIGHT_CORE_API module_element(std::shared_ptr<module> _module);
private:
std::weak_ptr<module> m_module; ///< Weak pointer to the module managing the element
bool m_enable {true}; ///< to know if module element is enabled
};
} // namespace sight::core::runtime
|
