annotate Framework/Plugins/StorageAreaBuffer.h @ 195:53bd9022c58b

Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 08 Jan 2021 18:54:20 +0100
parents a51ce147dbe0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
194
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
195
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
24 #include "../../Resources/Orthanc/Plugins/OrthancPluginCppWrapper.h"
194
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #include <boost/noncopyable.hpp>
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 #include <string>
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29
195
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
30
194
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 namespace OrthancDatabases
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 class StorageAreaBuffer : public boost::noncopyable
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 private:
195
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
36 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 9, 0)
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
37 OrthancPluginContext* context_;
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
38 OrthancPluginMemoryBuffer64 buffer_;
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
39 #else
194
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 void* data_;
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 int64_t size_;
195
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
42 #endif
194
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 public:
195
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
45 StorageAreaBuffer(OrthancPluginContext* context);
194
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 ~StorageAreaBuffer()
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 {
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 Clear();
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 }
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 void Clear();
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 void Assign(const std::string& content);
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
195
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
56 int64_t GetSize() const;
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
57
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
58 const void* GetData() const;
194
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
195
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
60 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 9, 0)
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
61 void Move(OrthancPluginMemoryBuffer64* target);
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
62 #else
194
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 void* ReleaseData();
195
53bd9022c58b Support of "OrthancPluginRegisterStorageArea2()" from Orthanc SDK 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
64 #endif
194
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 void ToString(std::string& target);
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 };
a51ce147dbe0 refactoring using new class StorageAreaBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 }