Mercurial > hg > orthanc

annotate OrthancServer/Plugins/Engine/OrthancPluginDatabaseV4.h @ 5083:75e949689c08 attach-custom-data

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
PluginDatabaseV4 to handle customData
author Alain Mazy <am@osimis.io>
date Wed, 14 Sep 2022 17:11:45 +0200
parents
children 8279eaab0d1d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5083
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
1 /**
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
5 * Copyright (C) 2017-2022 Osimis S.A., Belgium
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
6 * Copyright (C) 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
7 *
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
9 * modify it under the terms of the GNU General Public License as
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
10 * published by the Free Software Foundation, either version 3 of the
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
11 * License, or (at your option) any later version.
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
12 *
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
16 * General Public License for more details.
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
17 *
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
18 * You should have received a copy of the GNU General Public License
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
20 **/
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
21
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
22
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
23 #pragma once
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
24
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
25 #if ORTHANC_ENABLE_PLUGINS == 1
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
26
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
27 #include "../../../OrthancFramework/Sources/SharedLibrary.h"
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
28 #include "../../Sources/Database/IDatabaseWrapper.h"
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
29 #include "../Include/orthanc/OrthancCDatabasePlugin.h"
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
30 #include "PluginsErrorDictionary.h"
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
31
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
32 namespace Orthanc
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
33 {
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
34 class OrthancPluginDatabaseV4 : public IDatabaseWrapper
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
35 {
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
36 private:
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
37 class Transaction;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
38
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
39 SharedLibrary& library_;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
40 PluginsErrorDictionary& errorDictionary_;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
41 OrthancPluginDatabaseBackendV4 backend_;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
42 void* database_;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
43 std::string serverIdentifier_;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
44
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
45 void CheckSuccess(OrthancPluginErrorCode code) const;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
46
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
47 public:
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
48 OrthancPluginDatabaseV4(SharedLibrary& library,
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
49 PluginsErrorDictionary& errorDictionary,
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
50 const OrthancPluginDatabaseBackendV4* backend,
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
51 size_t backendSize,
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
52 void* database,
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
53 const std::string& serverIdentifier);
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
54
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
55 virtual ~OrthancPluginDatabaseV4();
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
56
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
57 virtual void Open() ORTHANC_OVERRIDE;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
58
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
59 virtual void Close() ORTHANC_OVERRIDE;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
60
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
61 const SharedLibrary& GetSharedLibrary() const
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
62 {
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
63 return library_;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
64 }
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
65
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
66 virtual void FlushToDisk() ORTHANC_OVERRIDE
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
67 {
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
68 }
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
69
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
70 virtual bool HasFlushToDisk() const ORTHANC_OVERRIDE
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
71 {
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
72 return false;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
73 }
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
74
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
75 virtual IDatabaseWrapper::ITransaction* StartTransaction(TransactionType type,
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
76 IDatabaseListener& listener)
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
77 ORTHANC_OVERRIDE;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
78
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
79 virtual unsigned int GetDatabaseVersion() ORTHANC_OVERRIDE;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
80
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
81 virtual void Upgrade(unsigned int targetVersion,
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
82 IStorageArea& storageArea) ORTHANC_OVERRIDE;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
83
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
84 virtual bool HasRevisionsSupport() const ORTHANC_OVERRIDE;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
85
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
86 virtual bool HasAttachmentCustomDataSupport() const ORTHANC_OVERRIDE;
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
87
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
88 };
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
89 }
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
90
75e949689c08 PluginDatabaseV4 to handle customData
Alain Mazy <am@osimis.io>
parents:
diff changeset
91 #endif