Mercurial > hg > orthanc

annotate OrthancFramework/Sources/FileStorage/IStorageArea.h @ 5594:a906dc19264c find-refactoring

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
created FindResponse::Resource::Format()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Sat, 04 May 2024 15:25:19 +0200
parents 48b8dae6dc77
children f7adfb22e20e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1396
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1250
diff changeset
4 * Department, University Hospital of Liege, Belgium
5485
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
5 * Copyright (C) 2017-2024 Osimis S.A., Belgium
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
6 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
9 * modify it under the terms of the GNU Lesser General Public License
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
10 * as published by the Free Software Foundation, either version 3 of
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
11 * the License, or (at your option) any later version.
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
16 * Lesser General Public License for more details.
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
18 * You should have received a copy of the GNU Lesser General Public
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
19 * License along with this program. If not, see
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
20 * <http://www.gnu.org/licenses/>.
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #pragma once
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
4484
64f06e7d5fc7 new abstraction IMemoryBuffer to avoid unnecessary copies of std::string buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
26 #include "../IMemoryBuffer.h"
1126
bf67431a7383 handling of file content type in IStorageArea
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1125
diff changeset
27 #include "../Enumerations.h"
bf67431a7383 handling of file content type in IStorageArea
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1125
diff changeset
28
4497
10357b2f7150 fix build on msvc 2008
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4495
diff changeset
29 #include <stdint.h>
1396
ac4efabeb80c Migration of the orthanc-client as a separate project
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
30 #include <string>
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
4497
10357b2f7150 fix build on msvc 2008
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4495
diff changeset
32
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 namespace Orthanc
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 class IStorageArea : public boost::noncopyable
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 {
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 public:
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 virtual ~IStorageArea()
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 {
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 }
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
1135
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1126
diff changeset
42 virtual void Create(const std::string& uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1126
diff changeset
43 const void* content,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1126
diff changeset
44 size_t size,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1126
diff changeset
45 FileContentType type) = 0;
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
4484
64f06e7d5fc7 new abstraction IMemoryBuffer to avoid unnecessary copies of std::string buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
47 virtual IMemoryBuffer* Read(const std::string& uuid,
64f06e7d5fc7 new abstraction IMemoryBuffer to avoid unnecessary copies of std::string buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
48 FileContentType type) = 0;
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
4495
fa2311f94d9f IStorageArea::ReadRange()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4484
diff changeset
50 virtual IMemoryBuffer* ReadRange(const std::string& uuid,
fa2311f94d9f IStorageArea::ReadRange()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4484
diff changeset
51 FileContentType type,
fa2311f94d9f IStorageArea::ReadRange()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4484
diff changeset
52 uint64_t start /* inclusive */,
fa2311f94d9f IStorageArea::ReadRange()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4484
diff changeset
53 uint64_t end /* exclusive */) = 0;
fa2311f94d9f IStorageArea::ReadRange()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4484
diff changeset
54
4498
7b99e8bb8246 IStorageArea::HasReadRange()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4497
diff changeset
55 virtual bool HasReadRange() const = 0;
7b99e8bb8246 IStorageArea::HasReadRange()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4497
diff changeset
56
1126
bf67431a7383 handling of file content type in IStorageArea
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1125
diff changeset
57 virtual void Remove(const std::string& uuid,
bf67431a7383 handling of file content type in IStorageArea
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1125
diff changeset
58 FileContentType type) = 0;
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 };
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 }