annotate Sources/Autogenerated/sdk_OrthancPluginInstanceOrigin.impl.h @ 192:b0f096d2339e java-code-model

documentation of orthanc.RegisterRestCallback()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 02 Jul 2024 18:25:53 +0200
parents 55473de7694f
children 3678a028f1f6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
fef9a239df5c adding auto-generated 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
1
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
fef9a239df5c adding auto-generated 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
1
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 typedef struct
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 {
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 PyObject_HEAD
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 } sdk_OrthancPluginInstanceOrigin_Object;
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 /**
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 * Static global structure => the fields that are beyond the last
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 * initialized field are set to zero.
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 * https://stackoverflow.com/a/11152199/881731
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 **/
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 static PyTypeObject sdk_OrthancPluginInstanceOrigin_Type = {
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 PyVarObject_HEAD_INIT(NULL, 0)
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 "orthanc.InstanceOrigin", /* tp_name */
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 sizeof(sdk_OrthancPluginInstanceOrigin_Object), /* tp_basicsize */
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 };
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 void RegisterOrthancPluginInstanceOriginEnumeration(PyObject* module)
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 sdk_OrthancPluginInstanceOrigin_Type.tp_new = PyType_GenericNew;
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 sdk_OrthancPluginInstanceOrigin_Type.tp_flags = Py_TPFLAGS_DEFAULT;
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 sdk_OrthancPluginInstanceOrigin_Type.tp_doc = "Generated from C enumeration OrthancPluginOrthancPluginInstanceOrigin";
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 sdk_OrthancPluginInstanceOrigin_Type.tp_dict = PyDict_New();
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 if (PyType_Ready(&sdk_OrthancPluginInstanceOrigin_Type) < 0)
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 {
171
c8de83fe7faa removed deprecation warnings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 166
diff changeset
53 ORTHANC_PLUGINS_LOG_ERROR("Cannot register Python enumeration: OrthancPluginInstanceOrigin");
1
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError);
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 }
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 /**
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 * Declare constants here (static members = class attributes)
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 * https://stackoverflow.com/a/8017906/881731
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 *
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 * "Static and class methods can be defined in tp_methods by adding
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 * METH_STATIC or METH_CLASS to the ml_flags field of the
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 * PyMethodDef structure. This is equivalent to @staticmethod and
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 * @classmethod decorators."
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 *
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 * "Class attributes can be added by setting the tp_dict to a
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 * dictionary with these attributes before calling PyType_Ready()
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 * (in your module initialization function)."
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 **/
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
128
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
71 {
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
72 PyObject* tmp = PyLong_FromLong(1);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
73 PyDict_SetItemString(sdk_OrthancPluginInstanceOrigin_Type.tp_dict, "UNKNOWN", tmp);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
74 Py_DECREF(tmp);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
75 }
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
76
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
77 {
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
78 PyObject* tmp = PyLong_FromLong(2);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
79 PyDict_SetItemString(sdk_OrthancPluginInstanceOrigin_Type.tp_dict, "DICOM_PROTOCOL", tmp);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
80 Py_DECREF(tmp);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
81 }
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
82
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
83 {
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
84 PyObject* tmp = PyLong_FromLong(3);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
85 PyDict_SetItemString(sdk_OrthancPluginInstanceOrigin_Type.tp_dict, "REST_API", tmp);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
86 Py_DECREF(tmp);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
87 }
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
88
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
89 {
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
90 PyObject* tmp = PyLong_FromLong(4);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
91 PyDict_SetItemString(sdk_OrthancPluginInstanceOrigin_Type.tp_dict, "PLUGIN", tmp);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
92 Py_DECREF(tmp);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
93 }
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
94
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
95 {
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
96 PyObject* tmp = PyLong_FromLong(5);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
97 PyDict_SetItemString(sdk_OrthancPluginInstanceOrigin_Type.tp_dict, "LUA", tmp);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
98 Py_DECREF(tmp);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
99 }
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
100
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
101 {
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
102 PyObject* tmp = PyLong_FromLong(6);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
103 PyDict_SetItemString(sdk_OrthancPluginInstanceOrigin_Type.tp_dict, "WEB_DAV", tmp);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
104 Py_DECREF(tmp);
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
105 }
5b59ebc267e1 fixed leaks in the initialization of the enums
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 101
diff changeset
106
1
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 Py_INCREF(&sdk_OrthancPluginInstanceOrigin_Type);
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 if (PyModule_AddObject(module, "InstanceOrigin", (PyObject *)&sdk_OrthancPluginInstanceOrigin_Type) < 0)
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 {
171
c8de83fe7faa removed deprecation warnings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 166
diff changeset
111 ORTHANC_PLUGINS_LOG_ERROR("Cannot register Python enumeration: OrthancPluginInstanceOrigin");
1
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 Py_DECREF(&sdk_OrthancPluginInstanceOrigin_Type);
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError);
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 }
fef9a239df5c adding auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 }