File: reset.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 (73 lines) | stat: -rw-r--r-- 1,956 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
/************************************************************************
 *
 * 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 <service/controller.hpp>

namespace sight::module::data
{

/**
 * @brief This service resets an object using the default constructor.
 *
 * @section XML XML Configuration
 * @code{.xml}
   <service uid="..." type="sight::module::data::reset" >
    <inout key="target" uid="..." />
   </service>
   @endcode
 *
 * @subsection In-Out In-Out
 * - \b target [sight::data::object]: define the target object to reset.
 */
class reset final : public service::controller
{
public:

    SIGHT_DECLARE_SERVICE(reset, service::controller);

    /// Creates the service.
    reset() = default;

    /// Destroys the service.
    ~reset() final = default;

protected:

    //// Configures the service
    void configuring(const config_t& _config) final;

    /// Does nothing.
    void starting() final;

    /// Resets the object
    void updating() final;

    /// Sets the output to null.
    void stopping() final;

private:

    sight::data::ptr<sight::data::object, sight::data::access::inout> m_target {this, "target", true};
};

} // namespace sight::module::data.