Mercurial > hg > orthanc
annotate OrthancServer/ServerEnumerations.h @ 2427:715476b5d671
fix
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 10 Oct 2017 13:00:20 +0200 |
parents | 7284093111b0 |
children | 878b59270859 |
rev | line source |
---|---|
183 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
1900 | 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1189
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
2244
a3a65de1840f
shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2208
diff
changeset
|
5 * Copyright (C) 2017 Osimis, Belgium |
183 | 6 * |
7 * This program is free software: you can redistribute it and/or | |
8 * modify it under the terms of the GNU General Public License as | |
9 * published by the Free Software Foundation, either version 3 of the | |
10 * License, or (at your option) any later version. | |
11 * | |
12 * In addition, as a special exception, the copyright holders of this | |
13 * program give permission to link the code of its release with the | |
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
15 * that use the same license as the "OpenSSL" library), and distribute | |
16 * the linked executables. You must obey the GNU General Public License | |
17 * in all respects for all of the code used other than "OpenSSL". If you | |
18 * modify file(s) with this exception, you may extend this exception to | |
19 * your version of the file(s), but you are not obligated to do so. If | |
20 * you do not wish to do so, delete this exception statement from your | |
21 * version. If you delete this exception statement from all source files | |
22 * in the program, then also delete it here. | |
23 * | |
24 * This program is distributed in the hope that it will be useful, but | |
25 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
27 * General Public License for more details. | |
28 * | |
29 * You should have received a copy of the GNU General Public License | |
30 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
31 **/ | |
32 | |
33 #pragma once | |
34 | |
204 | 35 #include <string> |
1006
649d47854314
proper handling of metadata in Store
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
789
diff
changeset
|
36 #include <map> |
204 | 37 |
562
f64e3838d6e1
refactoring enumerations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
559
diff
changeset
|
38 #include "../Core/Enumerations.h" |
1721
3bcb01028107
removed another flavor of ServerIndex::LookupIdentifier
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1701
diff
changeset
|
39 #include "../Core/DicomFormat/DicomTag.h" |
562
f64e3838d6e1
refactoring enumerations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
559
diff
changeset
|
40 |
183 | 41 namespace Orthanc |
42 { | |
43 enum SeriesStatus | |
44 { | |
45 SeriesStatus_Complete, | |
46 SeriesStatus_Missing, | |
47 SeriesStatus_Inconsistent, | |
48 SeriesStatus_Unknown | |
49 }; | |
50 | |
51 enum StoreStatus | |
52 { | |
53 StoreStatus_Success, | |
54 StoreStatus_AlreadyStored, | |
397
941ea46e9e26
lua filter of new instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
348
diff
changeset
|
55 StoreStatus_Failure, |
941ea46e9e26
lua filter of new instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
348
diff
changeset
|
56 StoreStatus_FilteredOut // Removed by NewInstanceFilter |
183 | 57 }; |
58 | |
1745
38dda23c7d7d
LookupIdentifierQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1739
diff
changeset
|
59 enum IdentifierConstraintType |
38dda23c7d7d
LookupIdentifierQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1739
diff
changeset
|
60 { |
38dda23c7d7d
LookupIdentifierQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1739
diff
changeset
|
61 IdentifierConstraintType_Equal, |
1746 | 62 IdentifierConstraintType_SmallerOrEqual, |
63 IdentifierConstraintType_GreaterOrEqual, | |
64 IdentifierConstraintType_Wildcard /* Case sensitive, "*" or "?" are the only allowed wildcards */ | |
1745
38dda23c7d7d
LookupIdentifierQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1739
diff
changeset
|
65 }; |
38dda23c7d7d
LookupIdentifierQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1739
diff
changeset
|
66 |
232
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
67 |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
68 /** |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
69 * WARNING: Do not change the explicit values in the enumerations |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
70 * below this point. This would result in incompatible databases |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
71 * between versions of Orthanc! |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
72 **/ |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
73 |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
74 enum GlobalProperty |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
75 { |
1668
de1413733c97
reconstructing main dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1555
diff
changeset
|
76 GlobalProperty_DatabaseSchemaVersion = 1, // Unused in the Orthanc core as of Orthanc 0.9.5 |
310 | 77 GlobalProperty_FlushSleep = 2, |
2300
cc92410cbed2
GlobalProperty_DatabasePatchLevel
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
78 GlobalProperty_AnonymizationSequence = 3, |
cc92410cbed2
GlobalProperty_DatabasePatchLevel
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
79 GlobalProperty_DatabasePatchLevel = 4 // Reserved for internal use of the database plugins |
232
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
80 }; |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
81 |
183 | 82 enum MetadataType |
83 { | |
232
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
84 MetadataType_Instance_IndexInSeries = 1, |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
85 MetadataType_Instance_ReceptionDate = 2, |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
86 MetadataType_Instance_RemoteAet = 3, |
306
326d5a4a5af3
modification of instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
252
diff
changeset
|
87 MetadataType_Series_ExpectedNumberOfInstances = 4, |
311 | 88 MetadataType_ModifiedFrom = 5, |
432 | 89 MetadataType_AnonymizedFrom = 6, |
435
28ba73274919
registration of user-defined metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
434
diff
changeset
|
90 MetadataType_LastUpdate = 7, |
2189
c4b3259c8bce
New metadata automatically computed at the instance level: "TransferSyntax"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
91 MetadataType_Instance_Origin = 8, // New in Orthanc 0.9.5 |
c4b3259c8bce
New metadata automatically computed at the instance level: "TransferSyntax"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
92 MetadataType_Instance_TransferSyntax = 9, // New in Orthanc 1.2.0 |
2208
90ea60bee5ff
New metadata automatically computed at the instance level: "SopClassUid"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2189
diff
changeset
|
93 MetadataType_Instance_SopClassUid = 10, // New in Orthanc 1.2.0 |
435
28ba73274919
registration of user-defined metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
434
diff
changeset
|
94 |
28ba73274919
registration of user-defined metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
434
diff
changeset
|
95 // Make sure that the value "65535" can be stored into this enumeration |
28ba73274919
registration of user-defined metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
434
diff
changeset
|
96 MetadataType_StartUser = 1024, |
28ba73274919
registration of user-defined metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
434
diff
changeset
|
97 MetadataType_EndUser = 65535 |
183 | 98 }; |
99 | |
100 enum ChangeType | |
101 { | |
102 ChangeType_CompletedSeries = 1, | |
232
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
103 ChangeType_NewInstance = 2, |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
104 ChangeType_NewPatient = 3, |
5368bbe813cf
refactoring of attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
105 ChangeType_NewSeries = 4, |
315 | 106 ChangeType_NewStudy = 5, |
107 ChangeType_AnonymizedStudy = 6, | |
108 ChangeType_AnonymizedSeries = 7, | |
109 ChangeType_ModifiedStudy = 8, | |
348
1082e8121d10
refactoring anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
315
diff
changeset
|
110 ChangeType_ModifiedSeries = 9, |
1082e8121d10
refactoring anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
315
diff
changeset
|
111 ChangeType_AnonymizedPatient = 10, |
511
3b735fdf320b
monitoring of stable patients/studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
437
diff
changeset
|
112 ChangeType_ModifiedPatient = 11, |
3b735fdf320b
monitoring of stable patients/studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
437
diff
changeset
|
113 ChangeType_StablePatient = 12, |
3b735fdf320b
monitoring of stable patients/studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
437
diff
changeset
|
114 ChangeType_StableStudy = 13, |
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1163
diff
changeset
|
115 ChangeType_StableSeries = 14, |
1773
613df4362575
New UpdatedAttachment and UpdatedMetadata events in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1772
diff
changeset
|
116 ChangeType_UpdatedAttachment = 15, |
613df4362575
New UpdatedAttachment and UpdatedMetadata events in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1772
diff
changeset
|
117 ChangeType_UpdatedMetadata = 16, |
1189
6b9b02a16e99
NewChildInstance change type
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1177
diff
changeset
|
118 |
6b9b02a16e99
NewChildInstance change type
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1177
diff
changeset
|
119 ChangeType_INTERNAL_LastLogged = 4095, |
6b9b02a16e99
NewChildInstance change type
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1177
diff
changeset
|
120 |
6b9b02a16e99
NewChildInstance change type
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1177
diff
changeset
|
121 // The changes below this point are not logged into the database |
6b9b02a16e99
NewChildInstance change type
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1177
diff
changeset
|
122 ChangeType_Deleted = 4096, |
6b9b02a16e99
NewChildInstance change type
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1177
diff
changeset
|
123 ChangeType_NewChildInstance = 4097 |
183 | 124 }; |
197
530a25320461
removal of text as ids in sqlite db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
183
diff
changeset
|
125 |
1006
649d47854314
proper handling of metadata in Store
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
789
diff
changeset
|
126 |
649d47854314
proper handling of metadata in Store
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
789
diff
changeset
|
127 |
435
28ba73274919
registration of user-defined metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
434
diff
changeset
|
128 void InitializeServerEnumerations(); |
28ba73274919
registration of user-defined metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
434
diff
changeset
|
129 |
28ba73274919
registration of user-defined metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
434
diff
changeset
|
130 void RegisterUserMetadata(int metadata, |
656 | 131 const std::string& name); |
435
28ba73274919
registration of user-defined metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
434
diff
changeset
|
132 |
28ba73274919
registration of user-defined metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
434
diff
changeset
|
133 MetadataType StringToMetadata(const std::string& str); |
28ba73274919
registration of user-defined metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
434
diff
changeset
|
134 |
437 | 135 std::string EnumerationToString(MetadataType type); |
435
28ba73274919
registration of user-defined metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
434
diff
changeset
|
136 |
696
4c1860179cc5
dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
137 void RegisterUserContentType(int contentType, |
1772
53e045b5a8ec
MIME content type can be associated to custom attachments (cf. "UserContentType")
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
138 const std::string& name, |
53e045b5a8ec
MIME content type can be associated to custom attachments (cf. "UserContentType")
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
139 const std::string& mime); |
696
4c1860179cc5
dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
140 |
4c1860179cc5
dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
141 FileContentType StringToContentType(const std::string& str); |
4c1860179cc5
dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
142 |
4c1860179cc5
dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
143 std::string EnumerationToString(FileContentType type); |
4c1860179cc5
dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
144 |
1772
53e045b5a8ec
MIME content type can be associated to custom attachments (cf. "UserContentType")
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
145 std::string GetFileContentMime(FileContentType type); |
53e045b5a8ec
MIME content type can be associated to custom attachments (cf. "UserContentType")
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
146 |
696
4c1860179cc5
dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
147 std::string GetBasePath(ResourceType type, |
4c1860179cc5
dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
148 const std::string& publicId); |
4c1860179cc5
dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
149 |
434
ccf3a0a43dac
EnumerationDictionary
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
432
diff
changeset
|
150 const char* EnumerationToString(SeriesStatus status); |
204 | 151 |
434
ccf3a0a43dac
EnumerationDictionary
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
432
diff
changeset
|
152 const char* EnumerationToString(StoreStatus status); |
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
206
diff
changeset
|
153 |
434
ccf3a0a43dac
EnumerationDictionary
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
432
diff
changeset
|
154 const char* EnumerationToString(ChangeType type); |
250
f23318b11b39
creation of zip files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
232
diff
changeset
|
155 |
1773
613df4362575
New UpdatedAttachment and UpdatedMetadata events in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1772
diff
changeset
|
156 bool IsUserMetadata(MetadataType type); |
183 | 157 } |