annotate OrthancServer/Sources/ExportedResource.h @ 5800:2854418a7c0d default

fix unit tests
author Alain Mazy <am@orthanc.team>
date Fri, 20 Sep 2024 16:05:04 +0200
parents f7adfb22e20e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1242
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1247
diff changeset
4 * Department, University Hospital of Liege, Belgium
5640
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
5485
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
1242
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 *
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * This program is free software: you can redistribute it and/or
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * modify it under the terms of the GNU General Public License as
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * published by the Free Software Foundation, either version 3 of the
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * License, or (at your option) any later version.
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 *
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * This program is distributed in the hope that it will be useful, but
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * General Public License for more details.
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 *
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * You should have received a copy of the GNU General Public License
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #pragma once
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #include "ServerEnumerations.h"
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
27 #include "../../OrthancFramework/Sources/Toolbox.h"
1242
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 #include <string>
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 #include <json/value.h>
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 namespace Orthanc
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 {
1247
32fcc5dc7562 abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1246
diff changeset
34 class ExportedResource
1242
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 private:
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 int64_t seq_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 ResourceType resourceType_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 std::string publicId_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 std::string modality_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 std::string date_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 std::string patientId_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 std::string studyInstanceUid_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 std::string seriesInstanceUid_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 std::string sopInstanceUid_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 public:
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 ExportedResource(int64_t seq,
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 ResourceType resourceType,
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 const std::string& publicId,
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 const std::string& modality,
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 const std::string& date,
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 const std::string& patientId,
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 const std::string& studyInstanceUid,
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 const std::string& seriesInstanceUid,
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 const std::string& sopInstanceUid) :
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 seq_(seq),
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 resourceType_(resourceType),
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 publicId_(publicId),
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 modality_(modality),
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 date_(date),
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 patientId_(patientId),
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 studyInstanceUid_(studyInstanceUid),
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 seriesInstanceUid_(seriesInstanceUid),
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 sopInstanceUid_(sopInstanceUid)
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 {
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 }
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 int64_t GetSeq() const
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 {
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 return seq_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 }
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 ResourceType GetResourceType() const
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 {
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 return resourceType_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 }
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 const std::string& GetPublicId() const
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 {
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 return publicId_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 }
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 const std::string& GetModality() const
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 {
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 return modality_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 }
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 const std::string& GetDate() const
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 {
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 return date_;
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 }
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93
1246
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
94 const std::string& GetPatientId() const
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
95 {
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
96 return patientId_;
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
97 }
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
98
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
99 const std::string& GetStudyInstanceUid() const
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
100 {
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
101 return studyInstanceUid_;
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
102 }
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
103
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
104 const std::string& GetSeriesInstanceUid() const
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
105 {
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
106 return seriesInstanceUid_;
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
107 }
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
108
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
109 const std::string& GetSopInstanceUid() const
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
110 {
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
111 return sopInstanceUid_;
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
112 }
54bf0f0245f4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1244
diff changeset
113
1247
32fcc5dc7562 abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1246
diff changeset
114 void Format(Json::Value& item) const;
1242
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 };
58e6a89c3ef4 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 }