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
|
/************************************************************************
*
* 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 <core/base.hpp>
#include <filesystem>
#include <set>
#include <string>
namespace sight::core::runtime
{
class extension;
struct extension_registry;
class executable;
class executable_factory;
class plugin;
class runtime;
/**
* @brief Defines the module class.
*
*/
class SIGHT_CORE_CLASS_API module
{
public:
/// Defines the extension container type.
using extension_container = std::set<std::shared_ptr<extension> >;
virtual ~module() = default;
/**
* @brief Retrieves the module identifier.
*
* @return a string containing the module identifier
*/
[[nodiscard]] SIGHT_CORE_API virtual const std::string& identifier() const = 0;
/**
* @brief Retrieves the library name if it exists.
*
* @return a path representing the module location, can be empty if no library is set
*/
[[nodiscard]] SIGHT_CORE_API virtual std::string get_library_name() const = 0;
/**
* @brief Retrieves the module location.
*
* @return a path representing the module location
*/
[[nodiscard]] SIGHT_CORE_API virtual const std::filesystem::path& get_library_location() const = 0;
/**
* @brief Retrieves the module location.
*
* @return a path representing the module location
*/
[[nodiscard]] SIGHT_CORE_API virtual const std::filesystem::path& get_resources_location() const = 0;
/**
* @brief Retrieves the class representing the module executable part.
*
* @return a string containing the module's plugin class
*/
[[nodiscard]] SIGHT_CORE_API virtual std::string get_class() const = 0;
/**
* @brief Retrieves the plugin instance for the specified module identifier.
*
* @return a shared pointer to a plugin instance or null if the module has not been started.
*/
[[nodiscard]] SIGHT_CORE_API virtual SPTR(plugin) get_plugin() const = 0;
/**
* @brief Retrieves the value of the given parameter
* @remark When no such parameter has been found, an empty string is returned.
* @param[in] _identifier a string containing a parameter identifier
* @return a string containing the parameter value
*/
[[nodiscard]] SIGHT_CORE_API virtual std::string get_parameter_value(const std::string& _identifier) const = 0;
/**
* @brief Tells if a parameter exists.
* @param _name name of parameter to test
* @return true or false
*/
[[nodiscard]] SIGHT_CORE_API virtual bool has_parameter(const std::string& _name) const = 0;
/**
* @brief Returns the list of extensions contained in this module.
*/
[[nodiscard]] SIGHT_CORE_API virtual extension_container extensions() const = 0;
/**
* @name State Management
*/
//@{
/**
* @brief Starts the module.
*
* @remark The module must be enabled to be able to start.
*/
SIGHT_CORE_API virtual void start() = 0;
SIGHT_CORE_API virtual void stop() = 0;
[[nodiscard]] SIGHT_CORE_API virtual bool is_started() const = 0;
/**
* @brief Tells if the module is enabled.
*/
[[nodiscard]] SIGHT_CORE_API virtual bool enabled() const = 0;
//@}
};
} // namespace sight::core::runtime
|
