Mercurial > hg > orthanc
annotate OrthancCppClient/SharedLibrary/AUTOGENERATED/OrthancCppClient.h @ 986:de18e90d5507
fix GetVoxelSizeZ
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 01 Jul 2014 16:51:18 +0200 |
parents | f2841a9e04cf |
children | 7cbcd580cd21 |
rev | line source |
---|---|
540 | 1 /** |
2 * Laaw - Lightweight, Automated API Wrapper | |
3 * Copyright (C) 2010-2013 Jomago - Alain Mazy, Benjamin Golinvaux, | |
4 * Sebastien Jodogne | |
5 * | |
6 * This program is free software: you can redistribute it and/or | |
7 * modify it under the terms of the GNU General Public License as | |
8 * published by the Free Software Foundation, either version 3 of the | |
9 * License, or (at your option) any later version. | |
10 * | |
11 * In addition, as a special exception, the copyright holders of this | |
12 * program give permission to link the code of its release with the | |
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
14 * that use the same license as the "OpenSSL" library), and distribute | |
15 * the linked executables. You must obey the GNU General Public License | |
16 * in all respects for all of the code used other than "OpenSSL". If you | |
17 * modify file(s) with this exception, you may extend this exception to | |
18 * your version of the file(s), but you are not obligated to do so. If | |
19 * you do not wish to do so, delete this exception statement from your | |
20 * version. If you delete this exception statement from all source files | |
21 * in the program, then also delete it here. | |
22 * | |
23 * This program is distributed in the hope that it will be useful, but | |
24 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
26 * General Public License for more details. | |
27 * | |
28 * You should have received a copy of the GNU General Public License | |
29 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
30 **/ | |
31 | |
32 | |
33 /** | |
34 * @file | |
35 **/ | |
36 | |
37 #pragma once | |
38 | |
39 #include <stdexcept> | |
40 #include <memory> | |
41 #include <string> | |
42 #include <string.h> | |
43 | |
44 #if defined(_WIN32) | |
45 | |
46 /******************************************************************** | |
47 ** This is the Windows-specific section | |
48 ********************************************************************/ | |
49 | |
50 #include <windows.h> | |
51 | |
52 /* cf. http://sourceforge.net/p/predef/wiki/Architectures/ */ | |
53 #ifdef _M_X64 | |
54 /* 64 bits target */ | |
55 #define LAAW_ORTHANC_CLIENT_CALL_CONV __fastcall | |
56 #define LAAW_ORTHANC_CLIENT_CALL_DECORATION(Name, StdCallSuffix) Name | |
57 #define LAAW_ORTHANC_CLIENT_DEFAULT_PATH "OrthancClient_Windows64.dll" | |
58 #else | |
59 /* 32 bits target */ | |
60 #define LAAW_ORTHANC_CLIENT_CALL_CONV __stdcall | |
61 #define LAAW_ORTHANC_CLIENT_CALL_DECORATION(Name, StdCallSuffix) "_" Name "@" StdCallSuffix | |
62 #define LAAW_ORTHANC_CLIENT_DEFAULT_PATH "OrthancClient_Windows32.dll" | |
63 #endif | |
64 | |
65 #define LAAW_ORTHANC_CLIENT_HANDLE_TYPE HINSTANCE | |
66 #define LAAW_ORTHANC_CLIENT_HANDLE_NULL 0 | |
67 #define LAAW_ORTHANC_CLIENT_FUNCTION_TYPE FARPROC | |
68 #define LAAW_ORTHANC_CLIENT_LOADER(path) LoadLibraryA(path) | |
69 #define LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle, name, decoration) GetProcAddress(handle, LAAW_ORTHANC_CLIENT_CALL_DECORATION(name, decoration)) | |
70 #define LAAW_ORTHANC_CLIENT_CLOSER(handle) FreeLibrary(handle) | |
71 | |
72 | |
73 /******************************************************************** | |
74 ** This is the Linux-specific section | |
75 ********************************************************************/ | |
76 | |
77 #elif defined (__linux) | |
78 | |
79 #include <stdlib.h> | |
80 #include <dlfcn.h> | |
81 | |
82 /* cf. http://sourceforge.net/p/predef/wiki/Architectures/ */ | |
83 #ifdef __amd64__ | |
629 | 84 #define LAAW_ORTHANC_CLIENT_DEFAULT_PATH "libOrthancClient.so.0.7" |
540 | 85 #else |
629 | 86 #define LAAW_ORTHANC_CLIENT_DEFAULT_PATH "libOrthancClient.so.0.7" |
540 | 87 #endif |
88 | |
89 #define LAAW_ORTHANC_CLIENT_CALL_CONV | |
90 #define LAAW_ORTHANC_CLIENT_HANDLE_TYPE void* | |
91 #define LAAW_ORTHANC_CLIENT_HANDLE_NULL NULL | |
92 #define LAAW_ORTHANC_CLIENT_FUNCTION_TYPE intptr_t | |
93 #define LAAW_ORTHANC_CLIENT_LOADER(path) dlopen(path, RTLD_LAZY) | |
94 #define LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle, name, decoration) (LAAW_ORTHANC_CLIENT_FUNCTION_TYPE) dlsym(handle, name) | |
95 #define LAAW_ORTHANC_CLIENT_CLOSER(handle) dlclose(handle) | |
96 | |
97 | |
98 #else | |
99 #error Please support your platform here | |
100 #endif | |
101 | |
102 | |
103 /******************************************************************** | |
104 ** Definition of the integer types | |
105 ********************************************************************/ | |
106 | |
107 #ifndef LAAW_INT8 // Only define the integer types once | |
108 | |
109 #if defined(__GNUC__) | |
110 | |
111 // Under GCC (including MinGW), the stdint.h standard header is used. | |
112 | |
113 #include <stdint.h> | |
114 | |
115 #define LAAW_INT8 int8_t | |
116 #define LAAW_UINT8 uint8_t | |
117 #define LAAW_INT16 int16_t | |
118 #define LAAW_UINT16 uint16_t | |
119 #define LAAW_INT32 int32_t | |
120 #define LAAW_UINT32 uint32_t | |
121 #define LAAW_INT64 int64_t | |
122 #define LAAW_UINT64 uint64_t | |
123 | |
124 #elif defined(_MSC_VER) | |
125 | |
126 // Under Visual Studio, it is required to define the various integer | |
127 // types by hand. | |
128 | |
129 #if (_MSC_VER < 1300) | |
130 typedef signed char LAAW_INT8; | |
131 typedef signed short LAAW_INT16; | |
132 typedef signed int LAAW_INT32; | |
133 typedef unsigned char LAAW_UINT8; | |
134 typedef unsigned short LAAW_UINT16; | |
135 typedef unsigned int LAAW_UINT32; | |
136 #else | |
137 typedef signed __int8 LAAW_INT8; | |
138 typedef signed __int16 LAAW_INT16; | |
139 typedef signed __int32 LAAW_INT32; | |
140 typedef unsigned __int8 LAAW_UINT8; | |
141 typedef unsigned __int16 LAAW_UINT16; | |
142 typedef unsigned __int32 LAAW_UINT32; | |
143 #endif | |
144 | |
145 typedef signed __int64 LAAW_INT64; | |
146 typedef unsigned __int64 LAAW_UINT64; | |
147 | |
148 #else | |
149 #error "Please support your compiler here" | |
150 #endif | |
151 | |
152 #endif | |
153 | |
154 | |
155 | |
156 | |
157 | |
158 /******************************************************************** | |
159 ** This is a shared section between Windows and Linux | |
160 ********************************************************************/ | |
161 | |
162 namespace OrthancClient { | |
163 /** | |
164 * @brief Exception class that is thrown by the functions of this shared library. | |
165 **/ | |
166 class OrthancClientException : public std::exception | |
167 { | |
168 private: | |
169 std::string message_; | |
170 | |
171 public: | |
172 /** | |
173 * @brief Constructs an exception. | |
174 * @param message The error message. | |
175 **/ | |
176 OrthancClientException(std::string message) : message_(message) | |
177 { | |
178 } | |
179 | |
180 ~OrthancClientException() throw() | |
181 { | |
182 } | |
183 | |
184 /** | |
185 * @brief Get the error message associated with this exception. | |
186 * @returns The error message. | |
187 **/ | |
188 const std::string& What() const throw() | |
189 { | |
190 return message_; | |
191 } | |
192 }; | |
193 } | |
194 | |
195 | |
196 namespace OrthancClient { namespace Internals { | |
197 /** | |
198 * This internal class implements a Singleton design pattern that will | |
199 * store a reference to the shared library handle, together with a | |
200 * pointer to each function in the shared library. | |
201 **/ | |
202 class Library | |
203 { | |
204 private: | |
205 LAAW_ORTHANC_CLIENT_HANDLE_TYPE handle_; | |
986 | 206 LAAW_ORTHANC_CLIENT_FUNCTION_TYPE functionsIndex_[63 + 1]; |
540 | 207 |
208 | |
209 | |
210 void Load(const char* sharedLibraryPath) | |
211 { | |
212 | |
213 if (handle_ != LAAW_ORTHANC_CLIENT_HANDLE_NULL) | |
214 { | |
215 // Do nothing if the library is already loaded | |
216 return; | |
217 } | |
218 | |
219 /* Setup the path to the default shared library if not provided */ | |
220 if (sharedLibraryPath == NULL) | |
221 { | |
222 sharedLibraryPath = LAAW_ORTHANC_CLIENT_DEFAULT_PATH; | |
223 } | |
224 | |
225 /* Load the shared library */ | |
226 handle_ = LAAW_ORTHANC_CLIENT_LOADER(sharedLibraryPath); | |
227 | |
228 | |
229 if (handle_ == LAAW_ORTHANC_CLIENT_HANDLE_NULL) | |
230 { | |
231 throw ::OrthancClient::OrthancClientException("Error loading shared library"); | |
232 } | |
233 | |
234 LoadFunctions(); | |
235 } | |
236 | |
237 inline void LoadFunctions(); | |
238 | |
239 void FreeString(char* str) | |
240 { | |
241 typedef void (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (char*); | |
986 | 242 Function function = (Function) GetFunction(63); |
540 | 243 function(str); |
244 } | |
245 | |
246 Library() | |
247 { | |
248 handle_ = LAAW_ORTHANC_CLIENT_HANDLE_NULL; | |
249 } | |
250 | |
251 ~Library() | |
252 { | |
253 Finalize(); | |
254 } | |
255 | |
256 public: | |
257 LAAW_ORTHANC_CLIENT_FUNCTION_TYPE GetFunction(unsigned int index) | |
258 { | |
259 /** | |
260 * If the library has not been manually initialized by a call to | |
261 * ::OrthancClient::Initialize(), it is loaded from | |
262 * the default location (lazy initialization). | |
263 **/ | |
264 if (handle_ == NULL) | |
265 { | |
266 Load(NULL); | |
267 } | |
268 | |
269 return functionsIndex_[index]; | |
270 } | |
271 | |
272 void ThrowExceptionIfNeeded(char* message) | |
273 { | |
274 if (message != NULL) | |
275 { | |
276 std::string tmp(message); | |
277 FreeString(message); | |
278 throw ::OrthancClient::OrthancClientException(tmp); | |
279 } | |
280 } | |
281 | |
282 static inline Library& GetInstance() | |
283 { | |
284 /** | |
285 * This function defines a "static variable" inside a "static | |
286 * inline method" of a class. This ensures that a single | |
287 * instance of this variable will be used across all the | |
288 * compilation modules of the software. | |
289 * http://stackoverflow.com/a/1389403/881731 | |
290 **/ | |
291 | |
292 static Library singleton; | |
293 return singleton; | |
294 } | |
295 | |
296 static void Initialize(const char* sharedLibraryPath) | |
297 { | |
298 GetInstance().Load(sharedLibraryPath); | |
299 } | |
300 | |
301 void Finalize() | |
302 { | |
303 if (handle_ != LAAW_ORTHANC_CLIENT_HANDLE_NULL) | |
304 { | |
305 LAAW_ORTHANC_CLIENT_CLOSER(handle_); | |
306 handle_ = LAAW_ORTHANC_CLIENT_HANDLE_NULL; | |
307 } | |
308 } | |
309 }; | |
310 }} | |
311 | |
312 | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
313 /*! |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
314 * \addtogroup Global Global definitions. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
315 * @{ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
316 * @} |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
317 */ |
540 | 318 |
319 | |
320 namespace OrthancClient { | |
321 /*! | |
322 * \addtogroup Initialization Initialization of the shared library. | |
323 * @{ | |
324 */ | |
325 | |
326 /** | |
327 * @brief Manually initialize the shared library, using the default library name. | |
328 * | |
329 * Call this method before using the library to ensure correct | |
330 * behaviour in multi-threaded applications. This method is also | |
331 * useful to control the time at which the shared library is | |
332 * loaded (e.g. for real-time applications). | |
333 **/ | |
334 inline void Initialize() | |
335 { | |
336 ::OrthancClient::Internals::Library::Initialize(NULL); | |
337 } | |
338 | |
339 /** | |
340 * @brief Manually initialize the shared library. | |
341 * | |
342 * Call this method before using the library to ensure correct | |
343 * behaviour in multi-threaded applications. This method is also | |
344 * useful to control the time at which the shared library is | |
345 * loaded (e.g. for real-time applications). | |
346 * | |
347 * @param sharedLibraryPath The path to the shared library that | |
348 * contains the module. | |
349 **/ | |
350 inline void Initialize(const std::string& sharedLibraryPath) | |
351 { | |
352 ::OrthancClient::Internals::Library::Initialize(sharedLibraryPath.c_str()); | |
353 } | |
354 | |
355 /** | |
356 * @brief Manually finalize the shared library. | |
357 * | |
358 * Calling explicitly this function is not mandatory. It is useful to | |
359 * force the release of the resources acquired by the shared library, | |
360 * or to manually control the order in which the global variables get | |
361 * deleted. | |
362 **/ | |
363 inline void Finalize() | |
364 { | |
365 ::OrthancClient::Internals::Library::GetInstance().Finalize(); | |
366 } | |
367 | |
368 | |
369 /** | |
370 * @} | |
371 */ | |
372 } | |
373 | |
374 | |
660 | 375 namespace OrthancClient { namespace Internals { |
376 inline void Library::LoadFunctions() | |
540 | 377 { |
378 typedef const char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (); | |
379 Function getVersion = (Function) LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_GetVersion", "0"); | |
380 if (getVersion == NULL) | |
381 { | |
382 throw ::OrthancClient::OrthancClientException("Unable to get the library version"); | |
383 } | |
384 | |
385 /** | |
386 * It is assumed that the API does not change when the revision | |
387 * number (MAJOR.MINOR.REVISION) changes. | |
388 **/ | |
629 | 389 if (strcmp(getVersion(), "0.7")) |
540 | 390 { |
391 throw ::OrthancClient::OrthancClientException("Mismatch between the C++ header and the library version"); | |
392 } | |
393 | |
986 | 394 functionsIndex_[63] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_FreeString", "4"); |
540 | 395 functionsIndex_[3] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_557aee7b61817292a0f31269d3c35db7", "8"); |
396 functionsIndex_[4] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_0b8dff0ce67f10954a49b059e348837e", "8"); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
397 functionsIndex_[5] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_e05097c153f676e5a5ee54dcfc78256f", "4"); |
540 | 398 functionsIndex_[6] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_e840242bf58d17d3c1d722da09ce88e0", "8"); |
399 functionsIndex_[7] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_c9af31433001b5dfc012a552dc6d0050", "8"); | |
400 functionsIndex_[8] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_3fba4d6b818180a44cd1cae6046334dc", "12"); | |
401 functionsIndex_[9] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_aeb20dc75b9246188db857317e5e0ce7", "8"); | |
402 functionsIndex_[10] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_62689803d9871e4d9c51a648640b320b", "8"); | |
403 functionsIndex_[11] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_2fb64c9e5a67eccd413b0e913469a421", "16"); | |
404 functionsIndex_[0] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_1f1acb322ea4d0aad65172824607673c", "8"); | |
405 functionsIndex_[1] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_f3fd272e4636f6a531aabb72ee01cd5b", "16"); | |
406 functionsIndex_[2] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_12d3de0a96e9efb11136a9811bb9ed38", "4"); | |
407 functionsIndex_[14] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_f756172daf04516eec3a566adabb4335", "4"); | |
408 functionsIndex_[15] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_ddb68763ec902a97d579666a73a20118", "8"); | |
409 functionsIndex_[16] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_fba3c68b4be7558dbc65f7ce1ab57d63", "12"); | |
410 functionsIndex_[17] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_b4ca99d958f843493e58d1ef967340e1", "8"); | |
411 functionsIndex_[18] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_78d5cc76d282437b6f93ec3b82c35701", "16"); | |
412 functionsIndex_[12] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_6cf0d7268667f9b0aa4511bacf184919", "12"); | |
413 functionsIndex_[13] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_7d81cd502ee27e859735d0ea7112b5a1", "4"); | |
414 functionsIndex_[21] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_48a2a1a9d68c047e22bfba23014643d2", "4"); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
415 functionsIndex_[22] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_852bf8296ca21c5fde5ec565cc10721d", "8"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
416 functionsIndex_[23] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_efd04574e0779faa83df1f2d8f9888db", "12"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
417 functionsIndex_[24] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_736247ff5e8036dac38163da6f666ed5", "8"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
418 functionsIndex_[25] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_d82d2598a7a73f4b6fcc0c09c25b08ca", "8"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
419 functionsIndex_[26] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_88134b978f9acb2aecdadf54aeab3c64", "16"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
420 functionsIndex_[27] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_152cb1b704c053d24b0dab7461ba6ea3", "8"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
421 functionsIndex_[28] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_eee03f337ec81d9f1783cd41e5238757", "8"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
422 functionsIndex_[29] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_006f08237bd7611636fc721baebfb4c5", "8"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
423 functionsIndex_[30] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_b794f5cd3dad7d7b575dd1fd902afdd0", "8"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
424 functionsIndex_[31] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_8ee2e50dd9df8f66a3c1766090dd03ab", "8"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
425 functionsIndex_[32] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_046aed35bbe4751691f4c34cc249a61d", "8"); |
986 | 426 functionsIndex_[33] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_2be452e7af5bf7dfd8c5021842674497", "8"); |
427 functionsIndex_[34] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_4dcc7a0fd025efba251ac6e9b701c2c5", "28"); | |
428 functionsIndex_[35] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_b2601a161c24ad0a1d3586246f87452c", "32"); | |
540 | 429 functionsIndex_[19] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_193599b9e345384fcdfcd47c29c55342", "12"); |
430 functionsIndex_[20] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_7c97f17063a357d38c5fab1136ad12a0", "4"); | |
986 | 431 functionsIndex_[38] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_e65b20b7e0170b67544cd6664a4639b7", "4"); |
432 functionsIndex_[39] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_470e981b0e41f17231ba0ae6f3033321", "8"); | |
433 functionsIndex_[40] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_04cefd138b6ea15ad909858f2a0a8f05", "12"); | |
434 functionsIndex_[41] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_aee5b1f6f0c082f2c3b0986f9f6a18c7", "8"); | |
435 functionsIndex_[42] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_93965682bace75491413e1f0b8d5a654", "16"); | |
436 functionsIndex_[36] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_b01c6003238eb46c8db5dc823d7ca678", "12"); | |
437 functionsIndex_[37] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_0147007fb99bad8cd95a139ec8795376", "4"); | |
438 functionsIndex_[45] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_236ee8b403bc99535a8a4695c0cd45cb", "8"); | |
439 functionsIndex_[46] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_2a437b7aba6bb01e81113835be8f0146", "8"); | |
440 functionsIndex_[47] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_2bcbcb850934ae0bb4c6f0cc940e6cda", "8"); | |
441 functionsIndex_[48] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_8d415c3a78a48e7e61d9fd24e7c79484", "12"); | |
442 functionsIndex_[49] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_70d2f8398bbc63b5f792b69b4ad5fecb", "12"); | |
443 functionsIndex_[50] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_1729a067d902771517388eedd7346b23", "12"); | |
444 functionsIndex_[51] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_72e2aeee66cd3abd8ab7e987321c3745", "8"); | |
445 functionsIndex_[52] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_1ea3df5a1ac1a1a687fe7325adddb6f0", "8"); | |
446 functionsIndex_[53] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_99b4f370e4f532d8b763e2cb49db92f8", "8"); | |
447 functionsIndex_[54] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_c41c742b68617f1c0590577a0a5ebc0c", "8"); | |
448 functionsIndex_[55] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_142dd2feba0fc1d262bbd0baeb441a8b", "8"); | |
449 functionsIndex_[56] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_5f5c9f81a4dff8daa6c359f1d0488fef", "12"); | |
450 functionsIndex_[57] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_9ca979fffd08fa256306d4e68d8b0e91", "8"); | |
451 functionsIndex_[58] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_6f2d77a26edc91c28d89408dbc3c271e", "8"); | |
452 functionsIndex_[59] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_c0f494b80d4ff8b232df7a75baa0700a", "4"); | |
453 functionsIndex_[60] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_d604f44bd5195e082e745e9cbc164f4c", "4"); | |
454 functionsIndex_[61] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_1710299d1c5f3b1f2b7cf3962deebbfd", "8"); | |
455 functionsIndex_[62] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_bb55aaf772ddceaadee36f4e54136bcb", "8"); | |
456 functionsIndex_[43] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_6c5ad02f91b583e29cebd0bd319ce21d", "12"); | |
457 functionsIndex_[44] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_4068241c44a9c1367fe0e57be523f207", "4"); | |
540 | 458 |
459 /* Check whether the functions were properly loaded */ | |
986 | 460 for (unsigned int i = 0; i <= 63; i++) |
540 | 461 { |
462 if (functionsIndex_[i] == (LAAW_ORTHANC_CLIENT_FUNCTION_TYPE) NULL) | |
463 { | |
464 throw ::OrthancClient::OrthancClientException("Unable to load the functions of the shared library"); | |
465 } | |
466 } | |
467 } | |
660 | 468 }} |
540 | 469 namespace OrthancClient |
470 { | |
471 class OrthancConnection; | |
472 } | |
473 | |
474 namespace OrthancClient | |
475 { | |
476 class Patient; | |
477 } | |
478 | |
479 namespace OrthancClient | |
480 { | |
481 class Series; | |
482 } | |
483 | |
484 namespace OrthancClient | |
485 { | |
486 class Study; | |
487 } | |
488 | |
489 namespace OrthancClient | |
490 { | |
491 class Instance; | |
492 } | |
493 | |
494 namespace Orthanc | |
495 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
496 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
497 * @brief The memory layout of the pixels (resp. voxels) of a 2D (resp. 3D) image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
498 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
499 * The memory layout of the pixels (resp. voxels) of a 2D (resp. 3D) image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
500 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
501 * @ingroup Global |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
502 **/ |
540 | 503 enum PixelFormat |
504 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
505 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
506 * @brief Graylevel, signed 16bpp image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
507 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
508 * The image is graylevel. Each pixel is signed and stored in two bytes. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
509 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
510 **/ |
865
f2841a9e04cf
force enumeration values in c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
820
diff
changeset
|
511 PixelFormat_SignedGrayscale16 = 5, |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
512 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
513 * @brief Color image in RGB24 format. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
514 * |
865
f2841a9e04cf
force enumeration values in c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
820
diff
changeset
|
515 * This format describes a color image. The pixels are stored in 3 consecutive bytes. The memory layout is RGB. |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
516 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
517 **/ |
865
f2841a9e04cf
force enumeration values in c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
820
diff
changeset
|
518 PixelFormat_RGB24 = 1, |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
519 /** |
820 | 520 * @brief Color image in RGBA32 format. |
521 * | |
865
f2841a9e04cf
force enumeration values in c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
820
diff
changeset
|
522 * This format describes a color image. The pixels are stored in 4 consecutive bytes. The memory layout is RGBA. |
820 | 523 * |
524 **/ | |
865
f2841a9e04cf
force enumeration values in c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
820
diff
changeset
|
525 PixelFormat_RGBA32 = 2, |
820 | 526 /** |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
527 * @brief Graylevel 8bpp image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
528 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
529 * The image is graylevel. Each pixel is unsigned and stored in one byte. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
530 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
531 **/ |
865
f2841a9e04cf
force enumeration values in c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
820
diff
changeset
|
532 PixelFormat_Grayscale8 = 3, |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
533 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
534 * @brief Graylevel, unsigned 16bpp image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
535 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
536 * The image is graylevel. Each pixel is unsigned and stored in two bytes. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
537 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
538 **/ |
865
f2841a9e04cf
force enumeration values in c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
820
diff
changeset
|
539 PixelFormat_Grayscale16 = 4 |
540 | 540 }; |
541 } | |
542 | |
543 namespace Orthanc | |
544 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
545 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
546 * @brief The extraction mode specifies the way the values of the pixels are scaled when downloading a 2D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
547 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
548 * The extraction mode specifies the way the values of the pixels are scaled when downloading a 2D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
549 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
550 * @ingroup Global |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
551 **/ |
540 | 552 enum ImageExtractionMode |
553 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
554 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
555 * @brief Truncation to the [-32768, 32767] range. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
556 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
557 * Truncation to the [-32768, 32767] range. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
558 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
559 **/ |
865
f2841a9e04cf
force enumeration values in c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
820
diff
changeset
|
560 ImageExtractionMode_Int16 = 4, |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
561 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
562 * @brief Rescaled to 8bpp. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
563 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
564 * The minimum value of the image is set to 0, and its maximum value is set to 255. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
565 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
566 **/ |
865
f2841a9e04cf
force enumeration values in c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
820
diff
changeset
|
567 ImageExtractionMode_Preview = 1, |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
568 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
569 * @brief Truncation to the [0, 255] range. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
570 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
571 * Truncation to the [0, 255] range. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
572 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
573 **/ |
865
f2841a9e04cf
force enumeration values in c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
820
diff
changeset
|
574 ImageExtractionMode_UInt8 = 2, |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
575 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
576 * @brief Truncation to the [0, 65535] range. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
577 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
578 * Truncation to the [0, 65535] range. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
579 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
580 **/ |
865
f2841a9e04cf
force enumeration values in c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
820
diff
changeset
|
581 ImageExtractionMode_UInt16 = 3 |
540 | 582 }; |
583 } | |
584 | |
585 namespace OrthancClient | |
586 { | |
573 | 587 /** |
588 * @brief Connection to an instance of %Orthanc. | |
589 * | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
590 * This class encapsulates a connection to a remote instance of %Orthanc through its REST API. |
573 | 591 * |
592 **/ | |
540 | 593 class OrthancConnection |
594 { | |
573 | 595 friend class ::OrthancClient::Patient; |
596 friend class ::OrthancClient::Series; | |
597 friend class ::OrthancClient::Study; | |
598 friend class ::OrthancClient::Instance; | |
540 | 599 private: |
600 bool isReference_; | |
591 | 601 OrthancConnection& operator= (const OrthancConnection&); // Assignment is forbidden |
540 | 602 void* pimpl_; |
603 OrthancConnection(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
604 public: |
591 | 605 /** |
606 * @brief Construct a new reference to this object. | |
607 * | |
608 * Construct a new reference to this object. Pay attention to the fact that when the referenced object is deleted, the content of this object will be invalid. | |
609 * | |
610 * @param other The original object. | |
611 **/ | |
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
612 OrthancConnection(const OrthancConnection& other) : isReference_(true), pimpl_(other.pimpl_) { } |
540 | 613 inline OrthancConnection(const ::std::string& orthancUrl); |
614 inline OrthancConnection(const ::std::string& orthancUrl, const ::std::string& username, const ::std::string& password); | |
615 inline ~OrthancConnection(); | |
616 inline LAAW_UINT32 GetThreadCount() const; | |
617 inline void SetThreadCount(LAAW_UINT32 threadCount); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
618 inline void Reload(); |
540 | 619 inline ::std::string GetOrthancUrl() const; |
620 inline LAAW_UINT32 GetPatientCount(); | |
621 inline ::OrthancClient::Patient GetPatient(LAAW_UINT32 index); | |
622 inline void DeletePatient(LAAW_UINT32 index); | |
623 inline void StoreFile(const ::std::string& filename); | |
624 inline void Store(const void* dicom, LAAW_UINT64 size); | |
625 }; | |
626 } | |
627 | |
628 namespace OrthancClient | |
629 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
630 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
631 * @brief Connection to a patient stored in %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
632 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
633 * This class encapsulates a connection to a patient from a remote instance of %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
634 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
635 **/ |
540 | 636 class Patient |
637 { | |
573 | 638 friend class ::OrthancClient::OrthancConnection; |
639 friend class ::OrthancClient::Series; | |
640 friend class ::OrthancClient::Study; | |
641 friend class ::OrthancClient::Instance; | |
540 | 642 private: |
643 bool isReference_; | |
591 | 644 Patient& operator= (const Patient&); // Assignment is forbidden |
540 | 645 void* pimpl_; |
646 Patient(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
647 public: |
591 | 648 /** |
649 * @brief Construct a new reference to this object. | |
650 * | |
651 * Construct a new reference to this object. Pay attention to the fact that when the referenced object is deleted, the content of this object will be invalid. | |
652 * | |
653 * @param other The original object. | |
654 **/ | |
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
655 Patient(const Patient& other) : isReference_(true), pimpl_(other.pimpl_) { } |
540 | 656 inline Patient(::OrthancClient::OrthancConnection& connection, const ::std::string& id); |
657 inline ~Patient(); | |
658 inline void Reload(); | |
659 inline LAAW_UINT32 GetStudyCount(); | |
660 inline ::OrthancClient::Study GetStudy(LAAW_UINT32 index); | |
661 inline ::std::string GetId() const; | |
662 inline ::std::string GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const; | |
663 }; | |
664 } | |
665 | |
666 namespace OrthancClient | |
667 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
668 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
669 * @brief Connection to a series stored in %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
670 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
671 * This class encapsulates a connection to a series from a remote instance of %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
672 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
673 **/ |
540 | 674 class Series |
675 { | |
573 | 676 friend class ::OrthancClient::OrthancConnection; |
677 friend class ::OrthancClient::Patient; | |
678 friend class ::OrthancClient::Study; | |
679 friend class ::OrthancClient::Instance; | |
540 | 680 private: |
681 bool isReference_; | |
591 | 682 Series& operator= (const Series&); // Assignment is forbidden |
540 | 683 void* pimpl_; |
684 Series(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
685 public: |
591 | 686 /** |
687 * @brief Construct a new reference to this object. | |
688 * | |
689 * Construct a new reference to this object. Pay attention to the fact that when the referenced object is deleted, the content of this object will be invalid. | |
690 * | |
691 * @param other The original object. | |
692 **/ | |
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
693 Series(const Series& other) : isReference_(true), pimpl_(other.pimpl_) { } |
540 | 694 inline Series(::OrthancClient::OrthancConnection& connection, const ::std::string& id); |
695 inline ~Series(); | |
696 inline void Reload(); | |
697 inline LAAW_UINT32 GetInstanceCount(); | |
698 inline ::OrthancClient::Instance GetInstance(LAAW_UINT32 index); | |
699 inline ::std::string GetId() const; | |
700 inline ::std::string GetUrl() const; | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
701 inline ::std::string GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const; |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
702 inline bool Is3DImage(); |
540 | 703 inline LAAW_UINT32 GetWidth(); |
704 inline LAAW_UINT32 GetHeight(); | |
705 inline float GetVoxelSizeX(); | |
706 inline float GetVoxelSizeY(); | |
707 inline float GetVoxelSizeZ(); | |
986 | 708 inline float GetSliceThickness(); |
540 | 709 inline void Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride); |
548 | 710 inline void Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride, float progress[]); |
540 | 711 }; |
712 } | |
713 | |
714 namespace OrthancClient | |
715 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
716 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
717 * @brief Connection to a study stored in %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
718 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
719 * This class encapsulates a connection to a study from a remote instance of %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
720 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
721 **/ |
540 | 722 class Study |
723 { | |
573 | 724 friend class ::OrthancClient::OrthancConnection; |
725 friend class ::OrthancClient::Patient; | |
726 friend class ::OrthancClient::Series; | |
727 friend class ::OrthancClient::Instance; | |
540 | 728 private: |
729 bool isReference_; | |
591 | 730 Study& operator= (const Study&); // Assignment is forbidden |
540 | 731 void* pimpl_; |
732 Study(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
733 public: |
591 | 734 /** |
735 * @brief Construct a new reference to this object. | |
736 * | |
737 * Construct a new reference to this object. Pay attention to the fact that when the referenced object is deleted, the content of this object will be invalid. | |
738 * | |
739 * @param other The original object. | |
740 **/ | |
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
741 Study(const Study& other) : isReference_(true), pimpl_(other.pimpl_) { } |
540 | 742 inline Study(::OrthancClient::OrthancConnection& connection, const ::std::string& id); |
743 inline ~Study(); | |
744 inline void Reload(); | |
745 inline LAAW_UINT32 GetSeriesCount(); | |
746 inline ::OrthancClient::Series GetSeries(LAAW_UINT32 index); | |
747 inline ::std::string GetId() const; | |
748 inline ::std::string GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const; | |
749 }; | |
750 } | |
751 | |
752 namespace OrthancClient | |
753 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
754 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
755 * @brief Connection to an instance stored in %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
756 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
757 * This class encapsulates a connection to an image instance from a remote instance of %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
758 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
759 **/ |
540 | 760 class Instance |
761 { | |
573 | 762 friend class ::OrthancClient::OrthancConnection; |
763 friend class ::OrthancClient::Patient; | |
764 friend class ::OrthancClient::Series; | |
765 friend class ::OrthancClient::Study; | |
540 | 766 private: |
767 bool isReference_; | |
591 | 768 Instance& operator= (const Instance&); // Assignment is forbidden |
540 | 769 void* pimpl_; |
770 Instance(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
771 public: |
591 | 772 /** |
773 * @brief Construct a new reference to this object. | |
774 * | |
775 * Construct a new reference to this object. Pay attention to the fact that when the referenced object is deleted, the content of this object will be invalid. | |
776 * | |
777 * @param other The original object. | |
778 **/ | |
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
779 Instance(const Instance& other) : isReference_(true), pimpl_(other.pimpl_) { } |
540 | 780 inline Instance(::OrthancClient::OrthancConnection& connection, const ::std::string& id); |
781 inline ~Instance(); | |
782 inline ::std::string GetId() const; | |
783 inline void SetImageExtractionMode(::Orthanc::ImageExtractionMode mode); | |
784 inline ::Orthanc::ImageExtractionMode GetImageExtractionMode() const; | |
785 inline ::std::string GetTagAsString(const ::std::string& tag) const; | |
786 inline float GetTagAsFloat(const ::std::string& tag) const; | |
787 inline LAAW_INT32 GetTagAsInt(const ::std::string& tag) const; | |
788 inline LAAW_UINT32 GetWidth(); | |
789 inline LAAW_UINT32 GetHeight(); | |
790 inline LAAW_UINT32 GetPitch(); | |
791 inline ::Orthanc::PixelFormat GetPixelFormat(); | |
792 inline const void* GetBuffer(); | |
793 inline const void* GetBuffer(LAAW_UINT32 y); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
794 inline LAAW_UINT64 GetDicomSize(); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
795 inline const void* GetDicom(); |
540 | 796 inline void DiscardImage(); |
797 inline void DiscardDicom(); | |
728
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
798 inline void LoadTagContent(const ::std::string& path); |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
799 inline ::std::string GetLoadedTagContent() const; |
540 | 800 }; |
801 } | |
802 | |
803 namespace OrthancClient | |
804 { | |
573 | 805 /** |
806 * @brief Create a connection to an instance of %Orthanc. | |
807 * | |
808 * Create a connection to an instance of %Orthanc. | |
809 * | |
810 * @param orthancUrl URL to which the REST API of %Orthanc is listening. | |
811 **/ | |
540 | 812 inline OrthancConnection::OrthancConnection(const ::std::string& orthancUrl) |
813 { | |
814 isReference_ = false; | |
815 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, const char*); | |
816 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(0); | |
817 char* error = function(&pimpl_, orthancUrl.c_str()); | |
818 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
819 } | |
573 | 820 /** |
821 * @brief Create a connection to an instance of %Orthanc, with authentication. | |
822 * | |
823 * Create a connection to an instance of %Orthanc, with authentication. | |
824 * | |
825 * @param orthancUrl URL to which the REST API of %Orthanc is listening. | |
826 * @param username The username. | |
827 * @param password The password. | |
828 **/ | |
540 | 829 inline OrthancConnection::OrthancConnection(const ::std::string& orthancUrl, const ::std::string& username, const ::std::string& password) |
830 { | |
831 isReference_ = false; | |
832 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, const char*, const char*, const char*); | |
833 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(1); | |
834 char* error = function(&pimpl_, orthancUrl.c_str(), username.c_str(), password.c_str()); | |
835 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
836 } | |
837 /** | |
838 * @brief Destructs the object. | |
839 * | |
840 * Destructs the object. | |
841 * | |
842 **/ | |
843 inline OrthancConnection::~OrthancConnection() | |
844 { | |
845 if (isReference_) return; | |
846 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
847 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(2); | |
848 char* error = function(pimpl_); | |
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
849 error = error; // Remove warning about unused variable |
540 | 850 } |
573 | 851 /** |
852 * @brief Returns the number of threads for this connection. | |
853 * | |
854 * Returns the number of simultaneous connections that are used when downloading information from this instance of %Orthanc. | |
855 * | |
856 * @return The number of threads. | |
857 **/ | |
540 | 858 inline LAAW_UINT32 OrthancConnection::GetThreadCount() const |
859 { | |
860 LAAW_UINT32 result_; | |
861 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, LAAW_UINT32*); | |
862 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(3); | |
863 char* error = function(pimpl_, &result_); | |
864 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
865 return result_; | |
866 } | |
573 | 867 /** |
868 * @brief Sets the number of threads for this connection. | |
869 * | |
870 * Sets the number of simultaneous connections that are used when downloading information from this instance of %Orthanc. | |
871 * | |
872 * @param threadCount The number of threads. | |
873 **/ | |
540 | 874 inline void OrthancConnection::SetThreadCount(LAAW_UINT32 threadCount) |
875 { | |
876 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32); | |
877 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(4); | |
878 char* error = function(pimpl_, threadCount); | |
879 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
880 } | |
573 | 881 /** |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
882 * @brief Reload the list of the patients. |
573 | 883 * |
884 * This method will reload the list of the patients from the remote instance of %Orthanc. Pay attention to the fact that the patients that have been previously returned by GetPatient() will be invalidated. | |
885 * | |
886 **/ | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
887 inline void OrthancConnection::Reload() |
540 | 888 { |
889 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
890 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(5); | |
891 char* error = function(pimpl_); | |
892 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
893 } | |
573 | 894 /** |
895 * @brief Returns the URL of this instance of %Orthanc. | |
896 * | |
897 * Returns the URL of the remote %Orthanc instance to which this object is connected. | |
898 * | |
899 * @return The URL. | |
900 **/ | |
540 | 901 inline ::std::string OrthancConnection::GetOrthancUrl() const |
902 { | |
903 const char* result_; | |
904 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
905 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(6); | |
906 char* error = function(pimpl_, &result_); | |
907 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
908 return std::string(result_); | |
909 } | |
573 | 910 /** |
911 * @brief Returns the number of patients. | |
912 * | |
913 * Returns the number of patients that are stored in the remote instance of %Orthanc. | |
914 * | |
915 * @return The number of patients. | |
916 **/ | |
540 | 917 inline LAAW_UINT32 OrthancConnection::GetPatientCount() |
918 { | |
919 LAAW_UINT32 result_; | |
920 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
921 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(7); | |
922 char* error = function(pimpl_, &result_); | |
923 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
924 return result_; | |
925 } | |
573 | 926 /** |
927 * @brief Get some patient. | |
928 * | |
929 * This method will return an object that contains information about some patient. The patients are indexed by a number between 0 (inclusive) and the result of GetPatientCount() (exclusive). | |
930 * | |
931 * @param index The index of the patient of interest. | |
932 * @return The patient. | |
933 **/ | |
540 | 934 inline ::OrthancClient::Patient OrthancConnection::GetPatient(LAAW_UINT32 index) |
935 { | |
936 void* result_; | |
937 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32); | |
938 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(8); | |
939 char* error = function(pimpl_, &result_, index); | |
940 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
941 return ::OrthancClient::Patient(result_); | |
942 } | |
573 | 943 /** |
944 * @brief Delete some patient. | |
945 * | |
946 * Delete some patient from the remote instance of %Orthanc. Pay attention to the fact that the patients that have been previously returned by GetPatient() will be invalidated. | |
947 * | |
948 * @param index The index of the patient of interest. | |
949 * @return The patient. | |
950 **/ | |
540 | 951 inline void OrthancConnection::DeletePatient(LAAW_UINT32 index) |
952 { | |
953 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32); | |
954 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(9); | |
955 char* error = function(pimpl_, index); | |
956 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
957 } | |
573 | 958 /** |
959 * @brief Send a DICOM file. | |
960 * | |
961 * This method will store a DICOM file in the remote instance of %Orthanc. Pay attention to the fact that the patients that have been previously returned by GetPatient() will be invalidated. | |
962 * | |
963 * @param filename Path to the DICOM file | |
964 **/ | |
540 | 965 inline void OrthancConnection::StoreFile(const ::std::string& filename) |
966 { | |
967 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const char*); | |
968 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(10); | |
969 char* error = function(pimpl_, filename.c_str()); | |
970 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
971 } | |
573 | 972 /** |
973 * @brief Send a DICOM file that is contained inside a memory buffer. | |
974 * | |
975 * This method will store a DICOM file in the remote instance of %Orthanc. Pay attention to the fact that the patients that have been previously returned by GetPatient() will be invalidated. | |
976 * | |
977 * @param dicom The memory buffer containing the DICOM file. | |
978 * @param size The size of the DICOM file. | |
979 **/ | |
540 | 980 inline void OrthancConnection::Store(const void* dicom, LAAW_UINT64 size) |
981 { | |
982 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void*, LAAW_UINT64); | |
983 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(11); | |
984 char* error = function(pimpl_, dicom, size); | |
985 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
986 } | |
987 } | |
988 | |
989 namespace OrthancClient | |
990 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
991 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
992 * @brief Create a connection to some patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
993 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
994 * Create a connection to some patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
995 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
996 * @param connection The remote instance of %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
997 * @param id The %Orthanc identifier of the patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
998 **/ |
540 | 999 inline Patient::Patient(::OrthancClient::OrthancConnection& connection, const ::std::string& id) |
1000 { | |
1001 isReference_ = false; | |
1002 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*); | |
1003 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(12); | |
1004 char* error = function(&pimpl_, connection.pimpl_, id.c_str()); | |
1005 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1006 } | |
1007 /** | |
1008 * @brief Destructs the object. | |
1009 * | |
1010 * Destructs the object. | |
1011 * | |
1012 **/ | |
1013 inline Patient::~Patient() | |
1014 { | |
1015 if (isReference_) return; | |
1016 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
1017 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(13); | |
1018 char* error = function(pimpl_); | |
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
1019 error = error; // Remove warning about unused variable |
540 | 1020 } |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1021 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1022 * @brief Reload the studies of this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1023 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1024 * This method will reload the list of the studies of this patient. Pay attention to the fact that the studies that have been previously returned by GetStudy() will be invalidated. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1025 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1026 **/ |
540 | 1027 inline void Patient::Reload() |
1028 { | |
1029 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
1030 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(14); | |
1031 char* error = function(pimpl_); | |
1032 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1033 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1034 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1035 * @brief Return the number of studies for this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1036 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1037 * Return the number of studies for this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1038 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1039 * @return The number of studies. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1040 **/ |
540 | 1041 inline LAAW_UINT32 Patient::GetStudyCount() |
1042 { | |
1043 LAAW_UINT32 result_; | |
1044 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
1045 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(15); | |
1046 char* error = function(pimpl_, &result_); | |
1047 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1048 return result_; | |
1049 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1050 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1051 * @brief Get some study of this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1052 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1053 * This method will return an object that contains information about some study. The studies are indexed by a number between 0 (inclusive) and the result of GetStudyCount() (exclusive). |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1054 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1055 * @param index The index of the study of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1056 * @return The study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1057 **/ |
540 | 1058 inline ::OrthancClient::Study Patient::GetStudy(LAAW_UINT32 index) |
1059 { | |
1060 void* result_; | |
1061 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32); | |
1062 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(16); | |
1063 char* error = function(pimpl_, &result_, index); | |
1064 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1065 return ::OrthancClient::Study(result_); | |
1066 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1067 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1068 * @brief Get the %Orthanc identifier of this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1069 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1070 * Get the %Orthanc identifier of this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1071 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1072 * @return The identifier. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1073 **/ |
540 | 1074 inline ::std::string Patient::GetId() const |
1075 { | |
1076 const char* result_; | |
1077 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
1078 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(17); | |
1079 char* error = function(pimpl_, &result_); | |
1080 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1081 return std::string(result_); | |
1082 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1083 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1084 * @brief Get the value of one of the main DICOM tags for this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1085 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1086 * Get the value of one of the main DICOM tags for this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1087 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1088 * @param tag The name of the tag of interest ("PatientName", "PatientID", "PatientSex" or "PatientBirthDate"). |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1089 * @param defaultValue The default value to be returned if this tag does not exist. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1090 * @return The value of the tag. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1091 **/ |
540 | 1092 inline ::std::string Patient::GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const |
1093 { | |
1094 const char* result_; | |
1095 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*, const char*); | |
1096 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(18); | |
1097 char* error = function(pimpl_, &result_, tag.c_str(), defaultValue.c_str()); | |
1098 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1099 return std::string(result_); | |
1100 } | |
1101 } | |
1102 | |
1103 namespace OrthancClient | |
1104 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1105 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1106 * @brief Create a connection to some series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1107 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1108 * Create a connection to some series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1109 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1110 * @param connection The remote instance of %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1111 * @param id The %Orthanc identifier of the series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1112 **/ |
540 | 1113 inline Series::Series(::OrthancClient::OrthancConnection& connection, const ::std::string& id) |
1114 { | |
1115 isReference_ = false; | |
1116 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*); | |
1117 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(19); | |
1118 char* error = function(&pimpl_, connection.pimpl_, id.c_str()); | |
1119 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1120 } | |
1121 /** | |
1122 * @brief Destructs the object. | |
1123 * | |
1124 * Destructs the object. | |
1125 * | |
1126 **/ | |
1127 inline Series::~Series() | |
1128 { | |
1129 if (isReference_) return; | |
1130 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
1131 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(20); | |
1132 char* error = function(pimpl_); | |
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
1133 error = error; // Remove warning about unused variable |
540 | 1134 } |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1135 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1136 * @brief Reload the instances of this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1137 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1138 * This method will reload the list of the instances of this series. Pay attention to the fact that the instances that have been previously returned by GetInstance() will be invalidated. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1139 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1140 **/ |
540 | 1141 inline void Series::Reload() |
1142 { | |
1143 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
1144 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(21); | |
1145 char* error = function(pimpl_); | |
1146 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1147 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1148 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1149 * @brief Return the number of instances for this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1150 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1151 * Return the number of instances for this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1152 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1153 * @return The number of instances. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1154 **/ |
540 | 1155 inline LAAW_UINT32 Series::GetInstanceCount() |
1156 { | |
1157 LAAW_UINT32 result_; | |
1158 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1159 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(22); |
540 | 1160 char* error = function(pimpl_, &result_); |
1161 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1162 return result_; | |
1163 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1164 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1165 * @brief Get some instance of this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1166 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1167 * This method will return an object that contains information about some instance. The instances are indexed by a number between 0 (inclusive) and the result of GetInstanceCount() (exclusive). |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1168 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1169 * @param index The index of the instance of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1170 * @return The instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1171 **/ |
540 | 1172 inline ::OrthancClient::Instance Series::GetInstance(LAAW_UINT32 index) |
1173 { | |
1174 void* result_; | |
1175 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1176 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(23); |
540 | 1177 char* error = function(pimpl_, &result_, index); |
1178 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1179 return ::OrthancClient::Instance(result_); | |
1180 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1181 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1182 * @brief Get the %Orthanc identifier of this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1183 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1184 * Get the %Orthanc identifier of this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1185 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1186 * @return The identifier. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1187 **/ |
540 | 1188 inline ::std::string Series::GetId() const |
1189 { | |
1190 const char* result_; | |
1191 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1192 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(24); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1193 char* error = function(pimpl_, &result_); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1194 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1195 return std::string(result_); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1196 } |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1197 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1198 * @brief Returns the URL to this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1199 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1200 * Returns the URL to this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1201 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1202 * @return The URL. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1203 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1204 inline ::std::string Series::GetUrl() const |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1205 { |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1206 const char* result_; |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1207 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); |
540 | 1208 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(25); |
1209 char* error = function(pimpl_, &result_); | |
1210 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1211 return std::string(result_); | |
1212 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1213 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1214 * @brief Get the value of one of the main DICOM tags for this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1215 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1216 * Get the value of one of the main DICOM tags for this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1217 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1218 * @param tag The name of the tag of interest ("Modality", "Manufacturer", "SeriesDate", "SeriesDescription", "SeriesInstanceUID"...). |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1219 * @param defaultValue The default value to be returned if this tag does not exist. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1220 * @return The value of the tag. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1221 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1222 inline ::std::string Series::GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const |
540 | 1223 { |
1224 const char* result_; | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1225 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*, const char*); |
540 | 1226 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(26); |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1227 char* error = function(pimpl_, &result_, tag.c_str(), defaultValue.c_str()); |
540 | 1228 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
1229 return std::string(result_); | |
1230 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1231 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1232 * @brief Test whether this series encodes a 3D image that can be downloaded from %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1233 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1234 * Test whether this series encodes a 3D image that can be downloaded from %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1235 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1236 * @return "true" if and only if this is a 3D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1237 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1238 inline bool Series::Is3DImage() |
540 | 1239 { |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1240 LAAW_INT32 result_; |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1241 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_INT32*); |
540 | 1242 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(27); |
1243 char* error = function(pimpl_, &result_); | |
1244 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1245 return result_ != 0; |
540 | 1246 } |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1247 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1248 * @brief Get the width of the 3D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1249 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1250 * Get the width of the 3D image (i.e. along the X-axis). This call is only valid if this series corresponds to a 3D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1251 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1252 * @return The width. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1253 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1254 inline LAAW_UINT32 Series::GetWidth() |
540 | 1255 { |
1256 LAAW_UINT32 result_; | |
1257 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
1258 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(28); | |
1259 char* error = function(pimpl_, &result_); | |
1260 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1261 return result_; | |
1262 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1263 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1264 * @brief Get the height of the 3D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1265 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1266 * Get the height of the 3D image (i.e. along the Y-axis). This call is only valid if this series corresponds to a 3D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1267 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1268 * @return The height. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1269 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1270 inline LAAW_UINT32 Series::GetHeight() |
540 | 1271 { |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1272 LAAW_UINT32 result_; |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1273 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); |
540 | 1274 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(29); |
1275 char* error = function(pimpl_, &result_); | |
1276 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1277 return result_; | |
1278 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1279 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1280 * @brief Get the physical size of a voxel along the X-axis. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1281 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1282 * Get the physical size of a voxel along the X-axis. This call is only valid if this series corresponds to a 3D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1283 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1284 * @return The voxel size. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1285 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1286 inline float Series::GetVoxelSizeX() |
540 | 1287 { |
1288 float result_; | |
1289 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*); | |
1290 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(30); | |
1291 char* error = function(pimpl_, &result_); | |
1292 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1293 return result_; | |
1294 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1295 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1296 * @brief Get the physical size of a voxel along the Y-axis. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1297 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1298 * Get the physical size of a voxel along the Y-axis. This call is only valid if this series corresponds to a 3D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1299 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1300 * @return The voxel size. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1301 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1302 inline float Series::GetVoxelSizeY() |
540 | 1303 { |
1304 float result_; | |
1305 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*); | |
1306 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(31); | |
1307 char* error = function(pimpl_, &result_); | |
1308 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1309 return result_; | |
1310 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1311 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1312 * @brief Get the physical size of a voxel along the Z-axis. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1313 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1314 * Get the physical size of a voxel along the Z-axis. This call is only valid if this series corresponds to a 3D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1315 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1316 * @return The voxel size. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1317 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1318 inline float Series::GetVoxelSizeZ() |
540 | 1319 { |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1320 float result_; |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1321 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*); |
540 | 1322 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(32); |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1323 char* error = function(pimpl_, &result_); |
540 | 1324 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1325 return result_; |
540 | 1326 } |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1327 /** |
986 | 1328 * @brief Get the slice thickness. |
1329 * | |
1330 * Get the slice thickness. This call is only valid if this series corresponds to a 3D image. | |
1331 * | |
1332 * @return The slice thickness. | |
1333 **/ | |
1334 inline float Series::GetSliceThickness() | |
1335 { | |
1336 float result_; | |
1337 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*); | |
1338 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(33); | |
1339 char* error = function(pimpl_, &result_); | |
1340 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1341 return result_; | |
1342 } | |
1343 /** | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1344 * @brief Load the 3D image into a memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1345 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1346 * Load the 3D image into a memory buffer. This call is only valid if this series corresponds to a 3D image. The "target" buffer must be wide enough to store all the voxels of the image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1347 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1348 * @param target The target memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1349 * @param format The memory layout of the voxels. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1350 * @param lineStride The number of bytes between two lines in the target memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1351 * @param stackStride The number of bytes between two 2D slices in the target memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1352 **/ |
540 | 1353 inline void Series::Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride) |
1354 { | |
1355 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void*, LAAW_INT32, LAAW_INT64, LAAW_INT64); | |
986 | 1356 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(34); |
540 | 1357 char* error = function(pimpl_, target, format, lineStride, stackStride); |
1358 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1359 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1360 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1361 * @brief Load the 3D image into a memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1362 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1363 * Load the 3D image into a memory buffer. This call is only valid if this series corresponds to a 3D image. The "target" buffer must be wide enough to store all the voxels of the image. This method will also update a progress indicator to monitor the loading of the image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1364 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1365 * @param target The target memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1366 * @param format The memory layout of the voxels. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1367 * @param lineStride The number of bytes between two lines in the target memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1368 * @param stackStride The number of bytes between two 2D slices in the target memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1369 * @param progress A pointer to a floating-point number that is continuously updated by the download threads to reflect the percentage of completion (between 0 and 1). This value can be read from a separate thread. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1370 **/ |
548 | 1371 inline void Series::Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride, float progress[]) |
1372 { | |
1373 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void*, LAAW_INT32, LAAW_INT64, LAAW_INT64, float*); | |
986 | 1374 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(35); |
548 | 1375 char* error = function(pimpl_, target, format, lineStride, stackStride, progress); |
1376 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1377 } | |
540 | 1378 } |
1379 | |
1380 namespace OrthancClient | |
1381 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1382 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1383 * @brief Create a connection to some study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1384 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1385 * Create a connection to some study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1386 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1387 * @param connection The remote instance of %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1388 * @param id The %Orthanc identifier of the study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1389 **/ |
540 | 1390 inline Study::Study(::OrthancClient::OrthancConnection& connection, const ::std::string& id) |
1391 { | |
1392 isReference_ = false; | |
1393 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*); | |
986 | 1394 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(36); |
540 | 1395 char* error = function(&pimpl_, connection.pimpl_, id.c_str()); |
1396 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1397 } | |
1398 /** | |
1399 * @brief Destructs the object. | |
1400 * | |
1401 * Destructs the object. | |
1402 * | |
1403 **/ | |
1404 inline Study::~Study() | |
1405 { | |
1406 if (isReference_) return; | |
1407 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
986 | 1408 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(37); |
540 | 1409 char* error = function(pimpl_); |
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
1410 error = error; // Remove warning about unused variable |
540 | 1411 } |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1412 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1413 * @brief Reload the series of this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1414 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1415 * This method will reload the list of the series of this study. Pay attention to the fact that the series that have been previously returned by GetSeries() will be invalidated. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1416 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1417 **/ |
540 | 1418 inline void Study::Reload() |
1419 { | |
1420 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
986 | 1421 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(38); |
540 | 1422 char* error = function(pimpl_); |
1423 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1424 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1425 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1426 * @brief Return the number of series for this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1427 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1428 * Return the number of series for this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1429 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1430 * @return The number of series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1431 **/ |
540 | 1432 inline LAAW_UINT32 Study::GetSeriesCount() |
1433 { | |
1434 LAAW_UINT32 result_; | |
1435 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
986 | 1436 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(39); |
540 | 1437 char* error = function(pimpl_, &result_); |
1438 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1439 return result_; | |
1440 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1441 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1442 * @brief Get some series of this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1443 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1444 * This method will return an object that contains information about some series. The series are indexed by a number between 0 (inclusive) and the result of GetSeriesCount() (exclusive). |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1445 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1446 * @param index The index of the series of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1447 * @return The series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1448 **/ |
540 | 1449 inline ::OrthancClient::Series Study::GetSeries(LAAW_UINT32 index) |
1450 { | |
1451 void* result_; | |
1452 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32); | |
986 | 1453 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(40); |
540 | 1454 char* error = function(pimpl_, &result_, index); |
1455 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1456 return ::OrthancClient::Series(result_); | |
1457 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1458 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1459 * @brief Get the %Orthanc identifier of this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1460 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1461 * Get the %Orthanc identifier of this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1462 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1463 * @return The identifier. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1464 **/ |
540 | 1465 inline ::std::string Study::GetId() const |
1466 { | |
1467 const char* result_; | |
1468 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
986 | 1469 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(41); |
540 | 1470 char* error = function(pimpl_, &result_); |
1471 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1472 return std::string(result_); | |
1473 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1474 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1475 * @brief Get the value of one of the main DICOM tags for this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1476 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1477 * Get the value of one of the main DICOM tags for this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1478 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1479 * @param tag The name of the tag of interest ("StudyDate", "StudyDescription", "StudyInstanceUID" or "StudyTime"). |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1480 * @param defaultValue The default value to be returned if this tag does not exist. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1481 * @return The value of the tag. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1482 **/ |
540 | 1483 inline ::std::string Study::GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const |
1484 { | |
1485 const char* result_; | |
1486 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*, const char*); | |
986 | 1487 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(42); |
540 | 1488 char* error = function(pimpl_, &result_, tag.c_str(), defaultValue.c_str()); |
1489 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1490 return std::string(result_); | |
1491 } | |
1492 } | |
1493 | |
1494 namespace OrthancClient | |
1495 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1496 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1497 * @brief Create a connection to some image instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1498 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1499 * Create a connection to some image instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1500 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1501 * @param connection The remote instance of %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1502 * @param id The %Orthanc identifier of the image instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1503 **/ |
540 | 1504 inline Instance::Instance(::OrthancClient::OrthancConnection& connection, const ::std::string& id) |
1505 { | |
1506 isReference_ = false; | |
1507 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*); | |
986 | 1508 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(43); |
540 | 1509 char* error = function(&pimpl_, connection.pimpl_, id.c_str()); |
1510 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1511 } | |
1512 /** | |
1513 * @brief Destructs the object. | |
1514 * | |
1515 * Destructs the object. | |
1516 * | |
1517 **/ | |
1518 inline Instance::~Instance() | |
1519 { | |
1520 if (isReference_) return; | |
1521 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
986 | 1522 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(44); |
540 | 1523 char* error = function(pimpl_); |
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
1524 error = error; // Remove warning about unused variable |
540 | 1525 } |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1526 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1527 * @brief Get the %Orthanc identifier of this identifier. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1528 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1529 * Get the %Orthanc identifier of this identifier. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1530 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1531 * @return The identifier. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1532 **/ |
540 | 1533 inline ::std::string Instance::GetId() const |
1534 { | |
1535 const char* result_; | |
1536 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
986 | 1537 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(45); |
540 | 1538 char* error = function(pimpl_, &result_); |
1539 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1540 return std::string(result_); | |
1541 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1542 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1543 * @brief Set the extraction mode for the 2D image corresponding to this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1544 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1545 * Set the extraction mode for the 2D image corresponding to this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1546 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1547 * @param mode The extraction mode. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1548 **/ |
540 | 1549 inline void Instance::SetImageExtractionMode(::Orthanc::ImageExtractionMode mode) |
1550 { | |
1551 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_INT32); | |
986 | 1552 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(46); |
540 | 1553 char* error = function(pimpl_, mode); |
1554 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1555 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1556 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1557 * @brief Get the extraction mode for the 2D image corresponding to this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1558 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1559 * Get the extraction mode for the 2D image corresponding to this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1560 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1561 * @return The extraction mode. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1562 **/ |
540 | 1563 inline ::Orthanc::ImageExtractionMode Instance::GetImageExtractionMode() const |
1564 { | |
1565 LAAW_INT32 result_; | |
1566 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, LAAW_INT32*); | |
986 | 1567 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(47); |
540 | 1568 char* error = function(pimpl_, &result_); |
1569 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1570 return static_cast< ::Orthanc::ImageExtractionMode >(result_); | |
1571 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1572 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1573 * @brief Get the string value of some DICOM tag of this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1574 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1575 * Get the string value of some DICOM tag of this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1576 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1577 * @param tag The name of the tag of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1578 * @return The value of the tag. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1579 **/ |
540 | 1580 inline ::std::string Instance::GetTagAsString(const ::std::string& tag) const |
1581 { | |
1582 const char* result_; | |
1583 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*); | |
986 | 1584 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(48); |
540 | 1585 char* error = function(pimpl_, &result_, tag.c_str()); |
1586 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1587 return std::string(result_); | |
1588 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1589 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1590 * @brief Get the floating point value that is stored in some DICOM tag of this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1591 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1592 * Get the floating point value that is stored in some DICOM tag of this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1593 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1594 * @param tag The name of the tag of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1595 * @return The value of the tag. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1596 **/ |
540 | 1597 inline float Instance::GetTagAsFloat(const ::std::string& tag) const |
1598 { | |
1599 float result_; | |
1600 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, float*, const char*); | |
986 | 1601 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(49); |
540 | 1602 char* error = function(pimpl_, &result_, tag.c_str()); |
1603 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1604 return result_; | |
1605 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1606 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1607 * @brief Get the integer value that is stored in some DICOM tag of this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1608 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1609 * Get the integer value that is stored in some DICOM tag of this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1610 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1611 * @param tag The name of the tag of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1612 * @return The value of the tag. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1613 **/ |
540 | 1614 inline LAAW_INT32 Instance::GetTagAsInt(const ::std::string& tag) const |
1615 { | |
1616 LAAW_INT32 result_; | |
1617 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, LAAW_INT32*, const char*); | |
986 | 1618 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(50); |
540 | 1619 char* error = function(pimpl_, &result_, tag.c_str()); |
1620 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1621 return result_; | |
1622 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1623 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1624 * @brief Get the width of the 2D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1625 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1626 * Get the width of the 2D image that is encoded by this DICOM instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1627 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1628 * @return The width. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1629 **/ |
540 | 1630 inline LAAW_UINT32 Instance::GetWidth() |
1631 { | |
1632 LAAW_UINT32 result_; | |
1633 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
986 | 1634 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(51); |
540 | 1635 char* error = function(pimpl_, &result_); |
1636 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1637 return result_; | |
1638 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1639 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1640 * @brief Get the height of the 2D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1641 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1642 * Get the height of the 2D image that is encoded by this DICOM instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1643 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1644 * @return The height. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1645 **/ |
540 | 1646 inline LAAW_UINT32 Instance::GetHeight() |
1647 { | |
1648 LAAW_UINT32 result_; | |
1649 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
986 | 1650 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(52); |
540 | 1651 char* error = function(pimpl_, &result_); |
1652 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1653 return result_; | |
1654 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1655 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1656 * @brief Get the number of bytes between two lines of the image (pitch). |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1657 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1658 * Get the number of bytes between two lines of the image in the memory buffer returned by GetBuffer(). This value depends on the extraction mode for the image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1659 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1660 * @return The pitch. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1661 **/ |
540 | 1662 inline LAAW_UINT32 Instance::GetPitch() |
1663 { | |
1664 LAAW_UINT32 result_; | |
1665 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
986 | 1666 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(53); |
540 | 1667 char* error = function(pimpl_, &result_); |
1668 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1669 return result_; | |
1670 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1671 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1672 * @brief Get the format of the pixels of the 2D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1673 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1674 * Return the memory layout that is used for the 2D image that is encoded by this DICOM instance. This value depends on the extraction mode for the image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1675 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1676 * @return The pixel format. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1677 **/ |
540 | 1678 inline ::Orthanc::PixelFormat Instance::GetPixelFormat() |
1679 { | |
1680 LAAW_INT32 result_; | |
1681 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_INT32*); | |
986 | 1682 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(54); |
540 | 1683 char* error = function(pimpl_, &result_); |
1684 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1685 return static_cast< ::Orthanc::PixelFormat >(result_); | |
1686 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1687 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1688 * @brief Access the memory buffer in which the raw pixels of the 2D image are stored. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1689 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1690 * Access the memory buffer in which the raw pixels of the 2D image are stored. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1691 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1692 * @return A pointer to the memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1693 **/ |
540 | 1694 inline const void* Instance::GetBuffer() |
1695 { | |
1696 const void* result_; | |
1697 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void**); | |
986 | 1698 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(55); |
540 | 1699 char* error = function(pimpl_, &result_); |
1700 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1701 return reinterpret_cast< const void* >(result_); | |
1702 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1703 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1704 * @brief Access the memory buffer in which the raw pixels of some line of the 2D image are stored. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1705 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1706 * Access the memory buffer in which the raw pixels of some line of the 2D image are stored. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1707 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1708 * @param y The line of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1709 * @return A pointer to the memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1710 **/ |
540 | 1711 inline const void* Instance::GetBuffer(LAAW_UINT32 y) |
1712 { | |
1713 const void* result_; | |
1714 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void**, LAAW_UINT32); | |
986 | 1715 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(56); |
540 | 1716 char* error = function(pimpl_, &result_, y); |
1717 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1718 return reinterpret_cast< const void* >(result_); | |
1719 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1720 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1721 * @brief Get the size of the DICOM file corresponding to this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1722 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1723 * Get the size of the DICOM file corresponding to this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1724 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1725 * @return The file size. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1726 **/ |
540 | 1727 inline LAAW_UINT64 Instance::GetDicomSize() |
1728 { | |
1729 LAAW_UINT64 result_; | |
1730 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT64*); | |
986 | 1731 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(57); |
540 | 1732 char* error = function(pimpl_, &result_); |
1733 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1734 return result_; | |
1735 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1736 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1737 * @brief Get a pointer to the content of the DICOM file corresponding to this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1738 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1739 * Get a pointer to the content of the DICOM file corresponding to this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1740 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1741 * @return The DICOM file. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1742 **/ |
540 | 1743 inline const void* Instance::GetDicom() |
1744 { | |
1745 const void* result_; | |
1746 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void**); | |
986 | 1747 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(58); |
540 | 1748 char* error = function(pimpl_, &result_); |
1749 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1750 return reinterpret_cast< const void* >(result_); | |
1751 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1752 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1753 * @brief Discard the downloaded 2D image, so as to make room in memory. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1754 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1755 * Discard the downloaded 2D image, so as to make room in memory. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1756 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1757 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1758 inline void Instance::DiscardImage() |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1759 { |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1760 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); |
986 | 1761 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(59); |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1762 char* error = function(pimpl_); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1763 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1764 } |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1765 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1766 * @brief Discard the downloaded DICOM file, so as to make room in memory. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1767 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1768 * Discard the downloaded DICOM file, so as to make room in memory. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1769 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1770 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1771 inline void Instance::DiscardDicom() |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1772 { |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1773 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); |
986 | 1774 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(60); |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1775 char* error = function(pimpl_); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1776 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1777 } |
728
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1778 /** |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1779 * @brief Load a raw tag from the DICOM file. |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1780 * |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1781 * Load a raw tag from the DICOM file. |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1782 * |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1783 * @param path The path to the tag of interest (e.g. "0020-000d"). |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1784 **/ |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1785 inline void Instance::LoadTagContent(const ::std::string& path) |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1786 { |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1787 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const char*); |
986 | 1788 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(61); |
728
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1789 char* error = function(pimpl_, path.c_str()); |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1790 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1791 } |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1792 /** |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1793 * @brief Return the value of the raw tag that was loaded by LoadContent. |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1794 * |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1795 * Return the value of the raw tag that was loaded by LoadContent. |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1796 * |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1797 * @return The tag value. |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1798 **/ |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1799 inline ::std::string Instance::GetLoadedTagContent() const |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1800 { |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1801 const char* result_; |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1802 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); |
986 | 1803 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(62); |
728
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1804 char* error = function(pimpl_, &result_); |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1805 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1806 return std::string(result_); |
d380222b4c2a
Load a raw tag from the DICOM file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1807 } |
540 | 1808 } |
1809 |