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
|
/************************************************************************
*
* 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/io/__/config.hpp>
#include <core/base.hpp>
#include <core/jobs/base.hpp>
#include <core/object.hpp>
#include <cstdint>
#include <filesystem>
#include <functional>
namespace sight::io::reader
{
/**
* @brief Base class for all object readers.
*
* This class defines the API to use basic object readers. This reader is not a
* service. Their equivalent exist as services. See io::service::reader. To read an
* object with this class, use setLocation and setObject method before executing
* the method read. Reading modifies the object given in parameter with the
* method set_object.
*/
class SIGHT_IO_CLASS_API object_reader : public core::base_object
{
public:
SIGHT_DECLARE_CLASS(object_reader, core::base_object);
using progress_callback = std::function<void (std::uint64_t)>;
using cancel_callback = std::function<void ()>;
/**
* @brief Defines an reader interface.
*
* This method (re)inits the object given in parameter of set_object method.
*/
SIGHT_IO_API virtual void read() = 0;
/**
* @brief m_object setter.
* @param[out] _p_object replaces weakptr m_object of the instance reader
* @note m_object is saved in class with a weakptr
* @note This object can be get with the method get_object()
*/
SIGHT_IO_API virtual void set_object(core::object::sptr _p_object);
/**
* @brief m_object getter.
*
* @return m_object
* @note m_object is saved in reader with a weakptr
*/
SIGHT_IO_API virtual core::object::sptr get_object() const;
SIGHT_IO_API virtual std::string extension() const = 0;
/**
* @brief Requests reader abortion.
*/
SIGHT_IO_API void cancel() const;
/// Returns the internal job
SIGHT_IO_API virtual SPTR(core::jobs::base) get_job() const
{
return nullptr;
}
protected:
/// Destructor. Does nothing.
SIGHT_IO_API ~object_reader() override = default;
/**
* @brief Object result of reading process.
*
* This object is given in parameter of set_object method but it is conserved with a weakptr.
*/
core::object::wptr m_object;
};
} // namespace sight::io::reader
|
