File: launcher.hpp

package info (click to toggle)
sight 25.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 42,180 kB
  • sloc: cpp: 289,476; xml: 17,257; ansic: 9,878; python: 1,379; sh: 144; makefile: 33
file content (81 lines) | stat: -rw-r--r-- 2,595 bytes parent folder | download | duplicates (2)
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
/************************************************************************
 *
 * Copyright (C) 2019-2024 IRCAD France
 * Copyright (C) 2019-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/activity/config.hpp>

#include "activity/extension/activity.hpp"

#include <data/activity.hpp>

#include <boost/property_tree/ptree.hpp>

#include <optional>

namespace sight::activity
{

/**
 * @brief Base class for services that launches Activity instances.
 */
class SIGHT_ACTIVITY_CLASS_API launcher
{
public:

    using configuration_t = boost::property_tree::ptree;
    using parameter_t     = activity::extension::activity_config_param;
    using parameters_t    = activity::extension::activity_config_params_type;
    using replace_map_t   = std::map<std::string, std::string>;
    using in_out_map_t    = std::vector<std::string>;

    /// Constructor. Do nothing.
    SIGHT_ACTIVITY_API launcher() = default;

    /// Destructor. Do nothing.
    SIGHT_ACTIVITY_API virtual ~launcher() = default;

protected:

    /// Parses the configuration
    SIGHT_ACTIVITY_API virtual void parse_configuration(
        const configuration_t& _config,
        const in_out_map_t& _inouts = in_out_map_t()
    );

    /// Create the activity given in 'mainActivity' configuration
    [[nodiscard]] SIGHT_ACTIVITY_API virtual data::activity::sptr create_main_activity() const;

    /**
     * @brief Check if the activity is valid by calling the activity validator.
     * @return Return true if the given activity is valid
     */
    static SIGHT_ACTIVITY_API std::pair<bool, std::string> validate_activity(
        const data::activity::csptr& _activity
    );

    std::string m_main_activity_id; ///< configuration id of the main activity

    parameters_t m_parameters; ///< parameters given in configuration
};

} // namespace sight::activity