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
|
/************************************************************************
*
* Copyright (C) 2015-2024 IRCAD France
* Copyright (C) 2015-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/app/config.hpp>
#include "app/extension/config.hpp"
#include <core/object.hpp>
#include <data/map.hpp>
#include <service/manager.hpp>
namespace sight::app
{
/**
* @brief This class provides an interface to manage configurations template.
* @deprecated This class is no longer supported, use app::config_manager.
*/
class SIGHT_APP_CLASS_API config_manager : public core::object,
public service::manager
{
public:
using config_t = boost::property_tree::ptree;
SIGHT_DECLARE_CLASS(config_manager, core::object);
/// Destructor. Do nothing.
SIGHT_APP_API ~config_manager() override = default;
/// Return a new config_manager implementation. Should be used for all the config_manager of the
/// application,
/// except the first one which must be explicitly called.
SIGHT_APP_API static SPTR(config_manager) make();
/// Return state
bool is_created() const;
bool started() const;
bool stopped() const;
bool is_destroyed() const;
/// Set configuration
void set_config(const config_t& _cfg);
/**
* @brief Set configuration
* @param _config_id the identifier of the requested config.
* @param _replace_fields the associations between the value and the pattern to replace in the config.
* @param _auto_prefix_id prefix every id with the name of the configuration .
*/
SIGHT_APP_API virtual void set_config(
const std::string& _config_id,
const field_adaptor_t& _replace_fields = field_adaptor_t(),
bool _auto_prefix_id = true
) = 0;
/// Get config root
SIGHT_APP_API virtual data::object::sptr get_config_root() const = 0;
/// Calls methods : create, start then update.
SIGHT_APP_API virtual void launch() = 0;
/// Stops and destroys services specified in config, then resets the configRoot sptr.
SIGHT_APP_API virtual void stop_and_destroy() = 0;
/// Creates objects and services from config
SIGHT_APP_API virtual void create() = 0;
/// Starts services specified in config
SIGHT_APP_API virtual void start() = 0;
/// Updates services specified in config
SIGHT_APP_API virtual void update() = 0;
/// Stops services specified in config
SIGHT_APP_API virtual void stop() = 0;
/// Destroys services specified in config
SIGHT_APP_API virtual void destroy() = 0;
protected:
/// Constructor. Does nothing.
SIGHT_APP_API config_manager() = default;
enum config_state
{
state_created,
state_started,
state_stopped,
state_destroyed
};
/// XML Configuration tree
core::runtime::config_t m_cfg_elem;
/// Running state of the app config manager
config_state m_state {state_destroyed};
};
//------------------------------------------------------------------------------
inline bool config_manager::is_created() const
{
return m_state == state_created;
}
//------------------------------------------------------------------------------
inline bool config_manager::started() const
{
return m_state == state_started;
}
//------------------------------------------------------------------------------
inline bool config_manager::stopped() const
{
return m_state == state_stopped;
}
//------------------------------------------------------------------------------
inline bool config_manager::is_destroyed() const
{
return m_state == state_destroyed;
}
//------------------------------------------------------------------------------
inline void config_manager::set_config(const config_t& _cfg)
{
m_cfg_elem = _cfg;
}
//------------------------------------------------------------------------------
} // namespace sight::app
|