annotate OrthancFramework/Sources/DicomParsing/ParsedDicomDir.h @ 5311:79fa77e9fa0d am-experimental

merge default -> am-experimental
author Alain Mazy <am@osimis.io>
date Fri, 16 Jun 2023 09:26:33 +0200
parents 0ea402b4d901
children 48b8dae6dc77
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3554
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
5185
0ea402b4d901 upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4870
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
0ea402b4d901 upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4870
diff changeset
6 * Copyright (C) 2021-2023 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
3554
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
8fe89c2ea593 new class: ParsedDicomDir
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: 4110
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: 4110
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: 4110
diff changeset
11 * the License, or (at your option) any later version.
3554
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
8fe89c2ea593 new class: ParsedDicomDir
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: 4110
diff changeset
16 * Lesser General Public License for more details.
3554
8fe89c2ea593 new class: ParsedDicomDir
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: 4110
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: 4110
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: 4110
diff changeset
20 * <http://www.gnu.org/licenses/>.
3554
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #pragma once
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #if ORTHANC_ENABLE_DCMTK != 1
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 # error The macro ORTHANC_ENABLE_DCMTK must be set to 1 to use this file
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 #endif
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 #include "../DicomFormat/DicomMap.h"
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 namespace Orthanc
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 {
4110
d99739cbe94c make DicomInstanceHasher and ParsedDicomDir public classes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
34 class ORTHANC_PUBLIC ParsedDicomDir : public boost::noncopyable
3554
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 private:
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 typedef std::map<uint32_t, size_t> OffsetToIndex;
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 std::vector<DicomMap*> content_;
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 std::vector<size_t> nextOffsets_;
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 std::vector<size_t> lowerOffsets_;
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 OffsetToIndex offsetToIndex_;
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 void Clear();
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 bool LookupIndexOfOffset(size_t& target,
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 unsigned int offset) const;
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 public:
4200
7112a8af0b63 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
50 explicit ParsedDicomDir(const std::string& content);
3554
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51
4297
785a2713323e abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4200
diff changeset
52 ~ParsedDicomDir();
3554
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
4297
785a2713323e abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4200
diff changeset
54 size_t GetSize() const;
3554
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 const DicomMap& GetItem(size_t i) const;
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 bool LookupNext(size_t& target,
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 size_t index) const;
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 bool LookupLower(size_t& target,
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 size_t index) const;
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 };
8fe89c2ea593 new class: ParsedDicomDir
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 }