annotate OrthancFramework/Sources/DicomParsing/ITagVisitor.h @ 4119:bf7b9edf6b81 framework-lgpl

re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 07 Jul 2020 19:17:56 +0200
parents d25f4c0fa160
children d9473bd5ed43
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2499
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3198
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
2499
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * 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
8 * 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
9 * 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
10 * the License, or (at your option) any later version.
2499
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * 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
15 * Lesser General Public License for more details.
2499
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
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
17 * 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
18 * 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
19 * <http://www.gnu.org/licenses/>.
2499
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "../DicomFormat/DicomTag.h"
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 #include <vector>
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 #include <boost/noncopyable.hpp>
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 namespace Orthanc
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 {
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 class ITagVisitor : public boost::noncopyable
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 {
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 public:
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 enum Action
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 {
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 Action_Replace,
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 Action_None
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 };
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 virtual ~ITagVisitor()
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 }
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44
3195
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
45 // Visiting a DICOM element that is internal to DCMTK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
46 virtual void VisitNotSupported(const std::vector<DicomTag>& parentTags,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
47 const std::vector<size_t>& parentIndexes,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
48 const DicomTag& tag,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
49 ValueRepresentation vr) = 0;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
50
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
51 // SQ
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
52 virtual void VisitEmptySequence(const std::vector<DicomTag>& parentTags,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
53 const std::vector<size_t>& parentIndexes,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
54 const DicomTag& tag) = 0;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
55
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
56 // SL, SS, UL, US
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
57 virtual void VisitIntegers(const std::vector<DicomTag>& parentTags,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
58 const std::vector<size_t>& parentIndexes,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
59 const DicomTag& tag,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
60 ValueRepresentation vr,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
61 const std::vector<int64_t>& values) = 0;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
62
3691
4922bdd046dd Fix issue #140 (Modifying private tags with REST API changes VR from LO to UN) - DANGEROUS COMMIT
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
63 // FL, FD, OD, OF
3195
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
64 virtual void VisitDoubles(const std::vector<DicomTag>& parentTags,
2499
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 const std::vector<size_t>& parentIndexes,
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 const DicomTag& tag,
3195
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
67 ValueRepresentation vr,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
68 const std::vector<double>& values) = 0;
2499
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69
3195
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
70 // AT
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
71 virtual void VisitAttributes(const std::vector<DicomTag>& parentTags,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
72 const std::vector<size_t>& parentIndexes,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
73 const DicomTag& tag,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
74 const std::vector<DicomTag>& values) = 0;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
75
3691
4922bdd046dd Fix issue #140 (Modifying private tags with REST API changes VR from LO to UN) - DANGEROUS COMMIT
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
76 // OB, OL, OW, UN
2499
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 virtual void VisitBinary(const std::vector<DicomTag>& parentTags,
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 const std::vector<size_t>& parentIndexes,
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 const DicomTag& tag,
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 ValueRepresentation vr,
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 const void* data,
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 size_t size) = 0;
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
3195
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3194
diff changeset
84 // Visiting an UTF-8 string
2499
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 virtual Action VisitString(std::string& newValue,
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 const std::vector<DicomTag>& parentTags,
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 const std::vector<size_t>& parentIndexes,
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 const DicomTag& tag,
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 ValueRepresentation vr,
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 const std::string& value) = 0;
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 };
83b8b6743531 ITagVisitor - for anonymization relationships
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 }