annotate Sources/Autogenerated/sdk_OrthancPluginFindMatcher.impl.h @ 212:2db6c1f6417f

documented orthanc.RegisterStorageArea()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 03 Jul 2024 14:39:25 +0200
parents 55473de7694f
children 3678a028f1f6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
42
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
ff5b71166c15 adding missing files
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: 155
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: 155
diff changeset
4 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
155
71d305c29cfa updated year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 131
diff changeset
5 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
42
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
186
55473de7694f added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 171
diff changeset
22 // WARNING: Auto-generated file. Do not modify it by hand.
55473de7694f added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 171
diff changeset
23
55473de7694f added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 171
diff changeset
24
63
32de70a1e4c7 New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 56
diff changeset
25 // Forward declaration of the autogenerated methods
32de70a1e4c7 New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 56
diff changeset
26 static PyObject *sdk_OrthancPluginFindMatcher_OrthancPluginFindMatcherIsMatch(
32de70a1e4c7 New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 56
diff changeset
27 sdk_OrthancPluginFindMatcher_Object* self, PyObject *args);
32de70a1e4c7 New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 56
diff changeset
28 // End of forward declarations
42
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
63
32de70a1e4c7 New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 56
diff changeset
31 // Forward declaration of the custom methods
32de70a1e4c7 New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 56
diff changeset
32 // End of forward declarations
42
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 static PyMethodDef sdk_OrthancPluginFindMatcher_Methods[] = {
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 { "FindMatcherIsMatch",
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 (PyCFunction) sdk_OrthancPluginFindMatcher_OrthancPluginFindMatcherIsMatch, METH_VARARGS,
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 "Generated from C function OrthancPluginFindMatcherIsMatch()" },
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 { NULL } /* Sentinel */
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 };
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 static int sdk_OrthancPluginFindMatcher_Constructor(
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 sdk_OrthancPluginFindMatcher_Object *self, PyObject *args, PyObject *kwds)
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 {
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 PythonLock::LogCall("Creating Python object of class OrthancPluginFindMatcher");
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 self->object_ = NULL;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 self->borrowed_ = false;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 long long object = 0;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 unsigned char borrowed = false;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 if (PyArg_ParseTuple(args, "Lb", &object, &borrowed))
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 {
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 self->object_ = reinterpret_cast<OrthancPluginFindMatcher*>(static_cast<intptr_t>(object));
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 self->borrowed_ = borrowed;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 return 0;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 }
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 else
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 {
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 PyErr_SetString(PyExc_ValueError, "Expected a pair (pointer, borrowed) in the constructor");
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 return -1;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 }
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 }
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 /**
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 * Static global structure => the fields that are beyond the last
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 * initialized field are set to zero.
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 * https://stackoverflow.com/a/11152199/881731
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 **/
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 static PyTypeObject sdk_OrthancPluginFindMatcher_Type = {
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 PyVarObject_HEAD_INIT(NULL, 0)
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 "orthanc.FindMatcher", /* tp_name */
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 sizeof(sdk_OrthancPluginFindMatcher_Object), /* tp_basicsize */
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 };
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 static void sdk_OrthancPluginFindMatcher_Destructor(PyObject *self)
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 {
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 PythonLock::LogCall("Destroying Python object of class OrthancPluginFindMatcher");
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 sdk_OrthancPluginFindMatcher_Object& tmp = *((sdk_OrthancPluginFindMatcher_Object*) self);
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 if (tmp.object_ != NULL &&
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 !tmp.borrowed_)
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 {
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 OrthancPluginFreeFindMatcher(OrthancPlugins::GetGlobalContext(), tmp.object_);
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 tmp.object_ = NULL;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 }
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 Py_TYPE(self)->tp_free((PyObject *)self);
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 }
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 static void RegisterOrthancPluginFindMatcherClass(PyObject* module)
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 {
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 sdk_OrthancPluginFindMatcher_Type.tp_new = PyType_GenericNew;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 sdk_OrthancPluginFindMatcher_Type.tp_flags = Py_TPFLAGS_DEFAULT;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 sdk_OrthancPluginFindMatcher_Type.tp_doc = "Generated from Orthanc C class: OrthancPluginFindMatcher";
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 sdk_OrthancPluginFindMatcher_Type.tp_methods = sdk_OrthancPluginFindMatcher_Methods;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 sdk_OrthancPluginFindMatcher_Type.tp_init = (initproc) sdk_OrthancPluginFindMatcher_Constructor;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 /**
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 * "tp_dealloc is called when the reference count of the object goes
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 * down to zero. This is where you destroy the object and its
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 * members. It should then free the memory occupied by the object by
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 * calling tp_free."
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 * https://stackoverflow.com/a/24863227/881731
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 **/
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 sdk_OrthancPluginFindMatcher_Type.tp_dealloc = sdk_OrthancPluginFindMatcher_Destructor;
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 if (PyType_Ready(&sdk_OrthancPluginFindMatcher_Type) < 0)
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 {
171
c8de83fe7faa removed deprecation warnings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 166
diff changeset
116 ORTHANC_PLUGINS_LOG_ERROR("Cannot register Python class: OrthancPluginFindMatcher");
42
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError);
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 }
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 Py_INCREF(&sdk_OrthancPluginFindMatcher_Type);
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121 if (PyModule_AddObject(module, "FindMatcher", (PyObject *)&sdk_OrthancPluginFindMatcher_Type) < 0)
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 {
171
c8de83fe7faa removed deprecation warnings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 166
diff changeset
123 ORTHANC_PLUGINS_LOG_ERROR("Cannot register Python class: OrthancPluginFindMatcher");
42
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 Py_DECREF(&sdk_OrthancPluginFindMatcher_Type);
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError);
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126 }
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127 }
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
129
63
32de70a1e4c7 New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 56
diff changeset
130 PyTypeObject* GetOrthancPluginFindMatcherType()
42
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
131 {
63
32de70a1e4c7 New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 56
diff changeset
132 return &sdk_OrthancPluginFindMatcher_Type;
42
ff5b71166c15 adding missing files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
133 }