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
|
/************************************************************************
*
* 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/buffer_tl.hpp"
#include "data/timeline/generic_object.hpp"
namespace sight::data
{
/**
* @brief This class defines a timeline of template objects. All objects have the same maximum number of elements,
* nevertheless it is not mandatory to provide all elements.
*/
template<class BUFFER_TYPE>
class generic_tl : public buffer_tl
{
public:
SIGHT_DECLARE_CLASS(generic_tl<BUFFER_TYPE>, buffer_tl);
using buffer_t = timeline::generic_object<BUFFER_TYPE>;
generic_tl();
~generic_tl() override = default;
/**
* @brief Returns the closest buffer to the given timestamp
* @param _timestamp timestamp used to find the closest buffer
* @param _direction direction to find the closest buffer (PAST, FUTURE, BOTH)
*/
CSPTR(buffer_t) get_closest_buffer(
core::clock::type _timestamp,
timeline::direction_t _direction = timeline::both
) const;
/// Returns the buffer matching the specified timestamp, returns NULL if object is not found
CSPTR(buffer_t) get_buffer(core::clock::type _timestamp) const;
/// Initializes the size of the pool buffer.
virtual void init_pool_size(unsigned int _max_element_num);
/**
* @brief Returns 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 timeline. You must call pushObject() to register it.
*/
SPTR(timeline::object) create_object(core::clock::type _timestamp) override;
/**
* @brief Returns a new buffer_t with the given timestamp.
* @note This buffer memory is managed by the pool.
* @warning This buffer is not registered in the timeline. You must call pushObject() to register it.
*/
SPTR(buffer_t) create_buffer(core::clock::type _timestamp);
/// Check if the type of an object is compatible with this timeline
bool is_object_valid(const CSPTR(timeline::object)& _obj) const override;
/// Get/set the maximum number of objects inside a single buffer
unsigned int get_max_element_num() const;
/// Equality comparison operators
/// @{
bool operator==(const generic_tl& _other) const noexcept;
bool operator!=(const generic_tl& _other) const noexcept;
/// @}
/// Defines shallow copy
/// @throws data::exception if an errors occurs during copy
/// @param[in] _source the source object to copy
void shallow_copy(const object::csptr& _source) override;
/// Defines deep copy
/// @throws data::exception if an errors occurs during copy
/// @param _source source object to copy
/// @param _cache cache used to deduplicate pointers
void deep_copy(
const object::csptr& _source,
const std::unique_ptr<deep_copy_cache_t>& _cache = std::make_unique<deep_copy_cache_t>()
) override;
protected:
/// maximum number of elements inside a single buffer
unsigned int m_max_element_num;
}; // class generic_tl
} // namespace sight::data
|
