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
|
/************************************************************************
*
* Copyright (C) 2009-2024 IRCAD France
* Copyright (C) 2012-2019 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/data/config.hpp>
#include "data/object.hpp"
#include "data/timeline/object.hpp"
namespace sight::data::timeline
{
enum direction_t
{
past = -1,
both = 0,
future = 1
};
struct signals
{
using pushed_t = core::com::signal<void (core::clock::type _timestamp)>;
using removed_t = core::com::signal<void (core::clock::type _timestamp)>;
using cleared_t = core::com::signal<void ()>;
inline static const core::com::signals::key_t PUSHED = "object_pushed";
inline static const core::com::signals::key_t REMOVED = "objectRemoved";
inline static const core::com::signals::key_t CLEARED = "objectCleared";
};
/**
* @brief This class defines the interface of base. Timeline is a collection of objects, each object being
* associated with a timestamp. It is intended to store lightweight objects.
*/
class SIGHT_DATA_CLASS_API base : public data::object
{
public:
SIGHT_DECLARE_CLASS(base, data::object);
SIGHT_DATA_API base();
SIGHT_DATA_API ~base() override = default;
/// Push an object to the base
SIGHT_DATA_API virtual void push_object(const SPTR(timeline::object)& _obj) = 0;
/// Removes an object from the base
SIGHT_DATA_API virtual SPTR(timeline::object) pop_object(core::clock::type _timestamp) = 0;
/// modify an object timestamp
SIGHT_DATA_API virtual void modify_time(
core::clock::type _timestamp,
core::clock::type _new_timestamp
) = 0;
/// Change an object to the specified timestamp
SIGHT_DATA_API virtual void set_object(
core::clock::type _timestamp,
const SPTR(timeline::object)& _obj
) = 0;
/**
* @brief Return a new timeline::object with the given timestamp.
* @note This buffer memory is managed by the pool.
* @warning This buffer is not registered in the base. You must call pushObject() to register it.
*/
SIGHT_DATA_API virtual SPTR(timeline::object) create_object(core::clock::type _timestamp) = 0;
/**
* @brief Return the closest object to the given timestamp
* @param _timestamp timestamp used to find the closest object
* @param _direction direction to find the closest object (PAST, FUTURE, BOTH)
*/
SIGHT_DATA_API virtual CSPTR(timeline::object) get_closest_object(
core::clock::type _timestamp,
direction_t _direction = both
) const = 0;
/// Return the object with the specified timestamp
SIGHT_DATA_API virtual CSPTR(timeline::object) get_object(core::clock::type _timestamp) const = 0;
/// Equality comparison operators
/// @{
SIGHT_DATA_API bool operator==(const base& _other) const noexcept;
SIGHT_DATA_API bool operator!=(const base& _other) const noexcept;
/// @}
protected:
/// Signal to emit when an object is pushed in the base.
signals::pushed_t::sptr m_sig_object_pushed;
/// Signal to emit when an object is removed in the base.
signals::pushed_t::sptr m_sig_object_removed;
}; // class base
} // namespace sight::data::timeline
|
