Mercurial > hg > orthanc-databases
annotate Framework/Plugins/IDatabaseBackendOutput.h @ 577:991b9b285e1a attach-custom-data tip
fix custom-data handling
author | Alain Mazy <am@orthanc.team> |
---|---|
date | Wed, 02 Oct 2024 09:40:20 +0200 |
parents | f18e46d7dbf8 |
children |
rev | line source |
---|---|
202 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
507
54d518dcd74a
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
459
diff
changeset
|
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
54d518dcd74a
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
459
diff
changeset
|
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
459
ecd0b719cff5
update year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
389
diff
changeset
|
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
202 | 8 * |
9 * This program is free software: you can redistribute it and/or | |
10 * modify it under the terms of the GNU Affero General Public License | |
11 * as published by the Free Software Foundation, either version 3 of | |
12 * the License, or (at your option) any later version. | |
13 * | |
14 * This program is distributed in the hope that it will be useful, but | |
15 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
17 * Affero General Public License for more details. | |
18 * | |
19 * You should have received a copy of the GNU Affero General Public License | |
20 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
21 **/ | |
22 | |
23 | |
24 #pragma once | |
25 | |
547
b8e6e7a19424
un-sharing DatabaseConstraint and ISqlLookupFormatter with Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
507
diff
changeset
|
26 #include "DatabaseConstraint.h" |
202 | 27 |
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
28 namespace OrthancDatabases |
202 | 29 { |
30 class IDatabaseBackendOutput : public boost::noncopyable | |
31 { | |
32 public: | |
232
4e15eace9b90
reorganization in DatabaseBackendAdapterV3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
206
diff
changeset
|
33 /** |
4e15eace9b90
reorganization in DatabaseBackendAdapterV3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
206
diff
changeset
|
34 * Contrarily to its parent "IDatabaseBackendOutput" class, the |
4e15eace9b90
reorganization in DatabaseBackendAdapterV3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
206
diff
changeset
|
35 * "IFactory" subclass *can* be invoked from multiple threads if |
4e15eace9b90
reorganization in DatabaseBackendAdapterV3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
206
diff
changeset
|
36 * used through "DatabaseBackendAdapterV3". Make sure to implement |
4e15eace9b90
reorganization in DatabaseBackendAdapterV3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
206
diff
changeset
|
37 * proper locking if need be. |
4e15eace9b90
reorganization in DatabaseBackendAdapterV3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
206
diff
changeset
|
38 **/ |
202 | 39 class IFactory : public boost::noncopyable |
40 { | |
41 public: | |
42 virtual ~IFactory() | |
43 { | |
44 } | |
45 | |
46 virtual IDatabaseBackendOutput* CreateOutput() = 0; | |
47 }; | |
48 | |
49 virtual ~IDatabaseBackendOutput() | |
50 { | |
51 } | |
52 | |
53 virtual void SignalDeletedAttachment(const std::string& uuid, | |
54 int32_t contentType, | |
55 uint64_t uncompressedSize, | |
56 const std::string& uncompressedHash, | |
57 int32_t compressionType, | |
58 uint64_t compressedSize, | |
366
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
232
diff
changeset
|
59 const std::string& compressedHash, |
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
232
diff
changeset
|
60 const std::string& customData) = 0; |
202 | 61 |
62 virtual void SignalDeletedResource(const std::string& publicId, | |
63 OrthancPluginResourceType resourceType) = 0; | |
64 | |
65 virtual void SignalRemainingAncestor(const std::string& ancestorId, | |
66 OrthancPluginResourceType ancestorType) = 0; | |
67 | |
68 virtual void AnswerAttachment(const std::string& uuid, | |
69 int32_t contentType, | |
70 uint64_t uncompressedSize, | |
71 const std::string& uncompressedHash, | |
72 int32_t compressionType, | |
73 uint64_t compressedSize, | |
366
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
232
diff
changeset
|
74 const std::string& compressedHash, |
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
232
diff
changeset
|
75 const std::string& customData) = 0; |
202 | 76 |
77 virtual void AnswerChange(int64_t seq, | |
78 int32_t changeType, | |
79 OrthancPluginResourceType resourceType, | |
80 const std::string& publicId, | |
81 const std::string& date) = 0; | |
82 | |
83 virtual void AnswerDicomTag(uint16_t group, | |
84 uint16_t element, | |
85 const std::string& value) = 0; | |
86 | |
87 virtual void AnswerExportedResource(int64_t seq, | |
88 OrthancPluginResourceType resourceType, | |
89 const std::string& publicId, | |
90 const std::string& modality, | |
91 const std::string& date, | |
92 const std::string& patientId, | |
93 const std::string& studyInstanceUid, | |
94 const std::string& seriesInstanceUid, | |
95 const std::string& sopInstanceUid) = 0; | |
206
6dcf57074dd4
starting OrthancPluginDatabaseBackendV3 wrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
203
diff
changeset
|
96 |
202 | 97 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1 |
98 virtual void AnswerMatchingResource(const std::string& resourceId) = 0; | |
99 #endif | |
100 | |
101 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1 | |
102 virtual void AnswerMatchingResource(const std::string& resourceId, | |
103 const std::string& someInstanceId) = 0; | |
104 #endif | |
105 }; | |
106 } |