annotate Sources/PythonBytes.h @ 195:d7a6e75558ee java-code-model

documented orthanc.RegisterOnChangeCallback()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 02 Jul 2024 18:56:28 +0200
parents 6fada29b6759
children 3678a028f1f6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
122
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Python plugin for Orthanc
166
6fada29b6759 updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
3 * Copyright (C) 2020-2023 Osimis S.A., Belgium
6fada29b6759 updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
4 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
6fada29b6759 updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
5 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
122
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #include "PythonObject.h"
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #include <Compatibility.h> // For std::unique_ptr
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 // A Python string is always valid, or an exception was thrown on its creation
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 class PythonBytes : public boost::noncopyable
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 {
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 private:
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 std::unique_ptr<PythonObject> bytes_;
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 void SanityCheck();
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 public:
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 PythonBytes(PythonLock& lock,
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 const void* data,
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 size_t size);
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 PyObject* GetPyObject() const
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 return bytes_->GetPyObject();
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 }
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 PyObject* Release()
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 {
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 return bytes_->Release();
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 }
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 };