Mercurial > hg > orthanc
annotate OrthancCppClient/SharedLibrary/AUTOGENERATED/OrthancCppClient.h @ 597:11a195070841 Orthanc-0.6.2
set version
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 04 Oct 2013 16:33:53 +0200 |
parents | 9d2592c08919 |
children | 84011417321d |
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__ | |
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
84 #define LAAW_ORTHANC_CLIENT_DEFAULT_PATH "libOrthancClient.so" |
540 | 85 #else |
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
86 #define LAAW_ORTHANC_CLIENT_DEFAULT_PATH "libOrthancClient.so" |
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_; | |
548 | 206 LAAW_ORTHANC_CLIENT_FUNCTION_TYPE functionsIndex_[60 + 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*); | |
548 | 242 Function function = (Function) GetFunction(60); |
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 | |
375 | |
376 void ::OrthancClient::Internals::Library::LoadFunctions() | |
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 **/ | |
571 | 389 if (strcmp(getVersion(), "0.6")) |
540 | 390 { |
391 throw ::OrthancClient::OrthancClientException("Mismatch between the C++ header and the library version"); | |
392 } | |
393 | |
548 | 394 functionsIndex_[60] = 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"); |
540 | 426 functionsIndex_[33] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_4dcc7a0fd025efba251ac6e9b701c2c5", "28"); |
548 | 427 functionsIndex_[34] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_b2601a161c24ad0a1d3586246f87452c", "32"); |
540 | 428 functionsIndex_[19] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_193599b9e345384fcdfcd47c29c55342", "12"); |
429 functionsIndex_[20] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_7c97f17063a357d38c5fab1136ad12a0", "4"); | |
548 | 430 functionsIndex_[37] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_e65b20b7e0170b67544cd6664a4639b7", "4"); |
431 functionsIndex_[38] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_470e981b0e41f17231ba0ae6f3033321", "8"); | |
432 functionsIndex_[39] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_04cefd138b6ea15ad909858f2a0a8f05", "12"); | |
433 functionsIndex_[40] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_aee5b1f6f0c082f2c3b0986f9f6a18c7", "8"); | |
434 functionsIndex_[41] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_93965682bace75491413e1f0b8d5a654", "16"); | |
435 functionsIndex_[35] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_b01c6003238eb46c8db5dc823d7ca678", "12"); | |
436 functionsIndex_[36] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_0147007fb99bad8cd95a139ec8795376", "4"); | |
437 functionsIndex_[44] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_236ee8b403bc99535a8a4695c0cd45cb", "8"); | |
438 functionsIndex_[45] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_2a437b7aba6bb01e81113835be8f0146", "8"); | |
439 functionsIndex_[46] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_2bcbcb850934ae0bb4c6f0cc940e6cda", "8"); | |
440 functionsIndex_[47] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_8d415c3a78a48e7e61d9fd24e7c79484", "12"); | |
441 functionsIndex_[48] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_70d2f8398bbc63b5f792b69b4ad5fecb", "12"); | |
442 functionsIndex_[49] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_1729a067d902771517388eedd7346b23", "12"); | |
443 functionsIndex_[50] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_72e2aeee66cd3abd8ab7e987321c3745", "8"); | |
444 functionsIndex_[51] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_1ea3df5a1ac1a1a687fe7325adddb6f0", "8"); | |
445 functionsIndex_[52] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_99b4f370e4f532d8b763e2cb49db92f8", "8"); | |
446 functionsIndex_[53] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_c41c742b68617f1c0590577a0a5ebc0c", "8"); | |
447 functionsIndex_[54] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_142dd2feba0fc1d262bbd0baeb441a8b", "8"); | |
448 functionsIndex_[55] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_5f5c9f81a4dff8daa6c359f1d0488fef", "12"); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
449 functionsIndex_[56] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_9ca979fffd08fa256306d4e68d8b0e91", "8"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
450 functionsIndex_[57] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_6f2d77a26edc91c28d89408dbc3c271e", "8"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
451 functionsIndex_[58] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_c0f494b80d4ff8b232df7a75baa0700a", "4"); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
452 functionsIndex_[59] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_d604f44bd5195e082e745e9cbc164f4c", "4"); |
548 | 453 functionsIndex_[42] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_6c5ad02f91b583e29cebd0bd319ce21d", "12"); |
454 functionsIndex_[43] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_4068241c44a9c1367fe0e57be523f207", "4"); | |
540 | 455 |
456 /* Check whether the functions were properly loaded */ | |
548 | 457 for (unsigned int i = 0; i <= 60; i++) |
540 | 458 { |
459 if (functionsIndex_[i] == (LAAW_ORTHANC_CLIENT_FUNCTION_TYPE) NULL) | |
460 { | |
461 throw ::OrthancClient::OrthancClientException("Unable to load the functions of the shared library"); | |
462 } | |
463 } | |
464 } | |
465 namespace OrthancClient | |
466 { | |
467 class OrthancConnection; | |
468 } | |
469 | |
470 namespace OrthancClient | |
471 { | |
472 class Patient; | |
473 } | |
474 | |
475 namespace OrthancClient | |
476 { | |
477 class Series; | |
478 } | |
479 | |
480 namespace OrthancClient | |
481 { | |
482 class Study; | |
483 } | |
484 | |
485 namespace OrthancClient | |
486 { | |
487 class Instance; | |
488 } | |
489 | |
490 namespace Orthanc | |
491 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
492 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
493 * @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
|
494 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
495 * 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
|
496 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
497 * @ingroup Global |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
498 **/ |
540 | 499 enum PixelFormat |
500 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
501 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
502 * @brief Graylevel, signed 16bpp image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
503 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
504 * 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
|
505 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
506 **/ |
540 | 507 PixelFormat_SignedGrayscale16 = 3, |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
508 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
509 * @brief Color image in RGB24 format. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
510 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
511 * Color image in RGB24 format. |
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 **/ |
540 | 514 PixelFormat_RGB24 = 0, |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
515 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
516 * @brief Graylevel 8bpp image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
517 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
518 * 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
|
519 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
520 **/ |
540 | 521 PixelFormat_Grayscale8 = 1, |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
522 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
523 * @brief Graylevel, unsigned 16bpp image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
524 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
525 * 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
|
526 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
527 **/ |
540 | 528 PixelFormat_Grayscale16 = 2 |
529 }; | |
530 } | |
531 | |
532 namespace Orthanc | |
533 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
534 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
535 * @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
|
536 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
537 * 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
|
538 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
539 * @ingroup Global |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
540 **/ |
540 | 541 enum ImageExtractionMode |
542 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
543 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
544 * @brief Truncation to the [-32768, 32767] range. |
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 * Truncation to the [-32768, 32767] range. |
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 **/ |
540 | 549 ImageExtractionMode_Int16 = 3, |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
550 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
551 * @brief Rescaled to 8bpp. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
552 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
553 * 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
|
554 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
555 **/ |
540 | 556 ImageExtractionMode_Preview = 0, |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
557 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
558 * @brief Truncation to the [0, 255] range. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
559 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
560 * Truncation to the [0, 255] range. |
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 **/ |
540 | 563 ImageExtractionMode_UInt8 = 1, |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
564 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
565 * @brief Truncation to the [0, 65535] range. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
566 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
567 * Truncation to the [0, 65535] range. |
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 **/ |
540 | 570 ImageExtractionMode_UInt16 = 2 |
571 }; | |
572 } | |
573 | |
574 namespace OrthancClient | |
575 { | |
573 | 576 /** |
577 * @brief Connection to an instance of %Orthanc. | |
578 * | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
579 * This class encapsulates a connection to a remote instance of %Orthanc through its REST API. |
573 | 580 * |
581 **/ | |
540 | 582 class OrthancConnection |
583 { | |
573 | 584 friend class ::OrthancClient::Patient; |
585 friend class ::OrthancClient::Series; | |
586 friend class ::OrthancClient::Study; | |
587 friend class ::OrthancClient::Instance; | |
540 | 588 private: |
589 bool isReference_; | |
591 | 590 OrthancConnection& operator= (const OrthancConnection&); // Assignment is forbidden |
540 | 591 void* pimpl_; |
592 OrthancConnection(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
593 public: |
591 | 594 /** |
595 * @brief Construct a new reference to this object. | |
596 * | |
597 * 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. | |
598 * | |
599 * @param other The original object. | |
600 **/ | |
601 OrthancConnection(const OrthancConnection& other) : pimpl_(other.pimpl_), isReference_(true) { } | |
540 | 602 inline OrthancConnection(const ::std::string& orthancUrl); |
603 inline OrthancConnection(const ::std::string& orthancUrl, const ::std::string& username, const ::std::string& password); | |
604 inline ~OrthancConnection(); | |
605 inline LAAW_UINT32 GetThreadCount() const; | |
606 inline void SetThreadCount(LAAW_UINT32 threadCount); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
607 inline void Reload(); |
540 | 608 inline ::std::string GetOrthancUrl() const; |
609 inline LAAW_UINT32 GetPatientCount(); | |
610 inline ::OrthancClient::Patient GetPatient(LAAW_UINT32 index); | |
611 inline void DeletePatient(LAAW_UINT32 index); | |
612 inline void StoreFile(const ::std::string& filename); | |
613 inline void Store(const void* dicom, LAAW_UINT64 size); | |
614 }; | |
615 } | |
616 | |
617 namespace OrthancClient | |
618 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
619 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
620 * @brief Connection to a patient stored in %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
621 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
622 * 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
|
623 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
624 **/ |
540 | 625 class Patient |
626 { | |
573 | 627 friend class ::OrthancClient::OrthancConnection; |
628 friend class ::OrthancClient::Series; | |
629 friend class ::OrthancClient::Study; | |
630 friend class ::OrthancClient::Instance; | |
540 | 631 private: |
632 bool isReference_; | |
591 | 633 Patient& operator= (const Patient&); // Assignment is forbidden |
540 | 634 void* pimpl_; |
635 Patient(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
636 public: |
591 | 637 /** |
638 * @brief Construct a new reference to this object. | |
639 * | |
640 * 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. | |
641 * | |
642 * @param other The original object. | |
643 **/ | |
644 Patient(const Patient& other) : pimpl_(other.pimpl_), isReference_(true) { } | |
540 | 645 inline Patient(::OrthancClient::OrthancConnection& connection, const ::std::string& id); |
646 inline ~Patient(); | |
647 inline void Reload(); | |
648 inline LAAW_UINT32 GetStudyCount(); | |
649 inline ::OrthancClient::Study GetStudy(LAAW_UINT32 index); | |
650 inline ::std::string GetId() const; | |
651 inline ::std::string GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const; | |
652 }; | |
653 } | |
654 | |
655 namespace OrthancClient | |
656 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
657 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
658 * @brief Connection to a series stored in %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
659 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
660 * 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
|
661 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
662 **/ |
540 | 663 class Series |
664 { | |
573 | 665 friend class ::OrthancClient::OrthancConnection; |
666 friend class ::OrthancClient::Patient; | |
667 friend class ::OrthancClient::Study; | |
668 friend class ::OrthancClient::Instance; | |
540 | 669 private: |
670 bool isReference_; | |
591 | 671 Series& operator= (const Series&); // Assignment is forbidden |
540 | 672 void* pimpl_; |
673 Series(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
674 public: |
591 | 675 /** |
676 * @brief Construct a new reference to this object. | |
677 * | |
678 * 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. | |
679 * | |
680 * @param other The original object. | |
681 **/ | |
682 Series(const Series& other) : pimpl_(other.pimpl_), isReference_(true) { } | |
540 | 683 inline Series(::OrthancClient::OrthancConnection& connection, const ::std::string& id); |
684 inline ~Series(); | |
685 inline void Reload(); | |
686 inline LAAW_UINT32 GetInstanceCount(); | |
687 inline ::OrthancClient::Instance GetInstance(LAAW_UINT32 index); | |
688 inline ::std::string GetId() const; | |
689 inline ::std::string GetUrl() const; | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
690 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
|
691 inline bool Is3DImage(); |
540 | 692 inline LAAW_UINT32 GetWidth(); |
693 inline LAAW_UINT32 GetHeight(); | |
694 inline float GetVoxelSizeX(); | |
695 inline float GetVoxelSizeY(); | |
696 inline float GetVoxelSizeZ(); | |
697 inline void Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride); | |
548 | 698 inline void Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride, float progress[]); |
540 | 699 }; |
700 } | |
701 | |
702 namespace OrthancClient | |
703 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
704 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
705 * @brief Connection to a study stored in %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
706 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
707 * 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
|
708 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
709 **/ |
540 | 710 class Study |
711 { | |
573 | 712 friend class ::OrthancClient::OrthancConnection; |
713 friend class ::OrthancClient::Patient; | |
714 friend class ::OrthancClient::Series; | |
715 friend class ::OrthancClient::Instance; | |
540 | 716 private: |
717 bool isReference_; | |
591 | 718 Study& operator= (const Study&); // Assignment is forbidden |
540 | 719 void* pimpl_; |
720 Study(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
721 public: |
591 | 722 /** |
723 * @brief Construct a new reference to this object. | |
724 * | |
725 * 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. | |
726 * | |
727 * @param other The original object. | |
728 **/ | |
729 Study(const Study& other) : pimpl_(other.pimpl_), isReference_(true) { } | |
540 | 730 inline Study(::OrthancClient::OrthancConnection& connection, const ::std::string& id); |
731 inline ~Study(); | |
732 inline void Reload(); | |
733 inline LAAW_UINT32 GetSeriesCount(); | |
734 inline ::OrthancClient::Series GetSeries(LAAW_UINT32 index); | |
735 inline ::std::string GetId() const; | |
736 inline ::std::string GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const; | |
737 }; | |
738 } | |
739 | |
740 namespace OrthancClient | |
741 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
742 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
743 * @brief Connection to an instance stored in %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
744 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
745 * 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
|
746 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
747 **/ |
540 | 748 class Instance |
749 { | |
573 | 750 friend class ::OrthancClient::OrthancConnection; |
751 friend class ::OrthancClient::Patient; | |
752 friend class ::OrthancClient::Series; | |
753 friend class ::OrthancClient::Study; | |
540 | 754 private: |
755 bool isReference_; | |
591 | 756 Instance& operator= (const Instance&); // Assignment is forbidden |
540 | 757 void* pimpl_; |
758 Instance(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
759 public: |
591 | 760 /** |
761 * @brief Construct a new reference to this object. | |
762 * | |
763 * 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. | |
764 * | |
765 * @param other The original object. | |
766 **/ | |
767 Instance(const Instance& other) : pimpl_(other.pimpl_), isReference_(true) { } | |
540 | 768 inline Instance(::OrthancClient::OrthancConnection& connection, const ::std::string& id); |
769 inline ~Instance(); | |
770 inline ::std::string GetId() const; | |
771 inline void SetImageExtractionMode(::Orthanc::ImageExtractionMode mode); | |
772 inline ::Orthanc::ImageExtractionMode GetImageExtractionMode() const; | |
773 inline ::std::string GetTagAsString(const ::std::string& tag) const; | |
774 inline float GetTagAsFloat(const ::std::string& tag) const; | |
775 inline LAAW_INT32 GetTagAsInt(const ::std::string& tag) const; | |
776 inline LAAW_UINT32 GetWidth(); | |
777 inline LAAW_UINT32 GetHeight(); | |
778 inline LAAW_UINT32 GetPitch(); | |
779 inline ::Orthanc::PixelFormat GetPixelFormat(); | |
780 inline const void* GetBuffer(); | |
781 inline const void* GetBuffer(LAAW_UINT32 y); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
782 inline LAAW_UINT64 GetDicomSize(); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
783 inline const void* GetDicom(); |
540 | 784 inline void DiscardImage(); |
785 inline void DiscardDicom(); | |
786 }; | |
787 } | |
788 | |
789 namespace OrthancClient | |
790 { | |
573 | 791 /** |
792 * @brief Create a connection to an instance of %Orthanc. | |
793 * | |
794 * Create a connection to an instance of %Orthanc. | |
795 * | |
796 * @param orthancUrl URL to which the REST API of %Orthanc is listening. | |
797 **/ | |
540 | 798 inline OrthancConnection::OrthancConnection(const ::std::string& orthancUrl) |
799 { | |
800 isReference_ = false; | |
801 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, const char*); | |
802 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(0); | |
803 char* error = function(&pimpl_, orthancUrl.c_str()); | |
804 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
805 } | |
573 | 806 /** |
807 * @brief Create a connection to an instance of %Orthanc, with authentication. | |
808 * | |
809 * Create a connection to an instance of %Orthanc, with authentication. | |
810 * | |
811 * @param orthancUrl URL to which the REST API of %Orthanc is listening. | |
812 * @param username The username. | |
813 * @param password The password. | |
814 **/ | |
540 | 815 inline OrthancConnection::OrthancConnection(const ::std::string& orthancUrl, const ::std::string& username, const ::std::string& password) |
816 { | |
817 isReference_ = false; | |
818 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, const char*, const char*, const char*); | |
819 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(1); | |
820 char* error = function(&pimpl_, orthancUrl.c_str(), username.c_str(), password.c_str()); | |
821 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
822 } | |
823 /** | |
824 * @brief Destructs the object. | |
825 * | |
826 * Destructs the object. | |
827 * | |
828 **/ | |
829 inline OrthancConnection::~OrthancConnection() | |
830 { | |
831 if (isReference_) return; | |
832 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
833 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(2); | |
834 char* error = function(pimpl_); | |
835 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
836 } | |
573 | 837 /** |
838 * @brief Returns the number of threads for this connection. | |
839 * | |
840 * Returns the number of simultaneous connections that are used when downloading information from this instance of %Orthanc. | |
841 * | |
842 * @return The number of threads. | |
843 **/ | |
540 | 844 inline LAAW_UINT32 OrthancConnection::GetThreadCount() const |
845 { | |
846 LAAW_UINT32 result_; | |
847 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, LAAW_UINT32*); | |
848 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(3); | |
849 char* error = function(pimpl_, &result_); | |
850 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
851 return result_; | |
852 } | |
573 | 853 /** |
854 * @brief Sets the number of threads for this connection. | |
855 * | |
856 * Sets the number of simultaneous connections that are used when downloading information from this instance of %Orthanc. | |
857 * | |
858 * @param threadCount The number of threads. | |
859 **/ | |
540 | 860 inline void OrthancConnection::SetThreadCount(LAAW_UINT32 threadCount) |
861 { | |
862 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32); | |
863 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(4); | |
864 char* error = function(pimpl_, threadCount); | |
865 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
866 } | |
573 | 867 /** |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
868 * @brief Reload the list of the patients. |
573 | 869 * |
870 * 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. | |
871 * | |
872 **/ | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
873 inline void OrthancConnection::Reload() |
540 | 874 { |
875 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
876 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(5); | |
877 char* error = function(pimpl_); | |
878 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
879 } | |
573 | 880 /** |
881 * @brief Returns the URL of this instance of %Orthanc. | |
882 * | |
883 * Returns the URL of the remote %Orthanc instance to which this object is connected. | |
884 * | |
885 * @return The URL. | |
886 **/ | |
540 | 887 inline ::std::string OrthancConnection::GetOrthancUrl() const |
888 { | |
889 const char* result_; | |
890 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
891 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(6); | |
892 char* error = function(pimpl_, &result_); | |
893 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
894 return std::string(result_); | |
895 } | |
573 | 896 /** |
897 * @brief Returns the number of patients. | |
898 * | |
899 * Returns the number of patients that are stored in the remote instance of %Orthanc. | |
900 * | |
901 * @return The number of patients. | |
902 **/ | |
540 | 903 inline LAAW_UINT32 OrthancConnection::GetPatientCount() |
904 { | |
905 LAAW_UINT32 result_; | |
906 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
907 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(7); | |
908 char* error = function(pimpl_, &result_); | |
909 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
910 return result_; | |
911 } | |
573 | 912 /** |
913 * @brief Get some patient. | |
914 * | |
915 * 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). | |
916 * | |
917 * @param index The index of the patient of interest. | |
918 * @return The patient. | |
919 **/ | |
540 | 920 inline ::OrthancClient::Patient OrthancConnection::GetPatient(LAAW_UINT32 index) |
921 { | |
922 void* result_; | |
923 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32); | |
924 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(8); | |
925 char* error = function(pimpl_, &result_, index); | |
926 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
927 return ::OrthancClient::Patient(result_); | |
928 } | |
573 | 929 /** |
930 * @brief Delete some patient. | |
931 * | |
932 * 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. | |
933 * | |
934 * @param index The index of the patient of interest. | |
935 * @return The patient. | |
936 **/ | |
540 | 937 inline void OrthancConnection::DeletePatient(LAAW_UINT32 index) |
938 { | |
939 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32); | |
940 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(9); | |
941 char* error = function(pimpl_, index); | |
942 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
943 } | |
573 | 944 /** |
945 * @brief Send a DICOM file. | |
946 * | |
947 * 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. | |
948 * | |
949 * @param filename Path to the DICOM file | |
950 **/ | |
540 | 951 inline void OrthancConnection::StoreFile(const ::std::string& filename) |
952 { | |
953 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const char*); | |
954 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(10); | |
955 char* error = function(pimpl_, filename.c_str()); | |
956 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
957 } | |
573 | 958 /** |
959 * @brief Send a DICOM file that is contained inside a memory buffer. | |
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 dicom The memory buffer containing the DICOM file. | |
964 * @param size The size of the DICOM file. | |
965 **/ | |
540 | 966 inline void OrthancConnection::Store(const void* dicom, LAAW_UINT64 size) |
967 { | |
968 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void*, LAAW_UINT64); | |
969 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(11); | |
970 char* error = function(pimpl_, dicom, size); | |
971 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
972 } | |
973 } | |
974 | |
975 namespace OrthancClient | |
976 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
977 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
978 * @brief Create a connection to some patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
979 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
980 * Create a connection to some patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
981 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
982 * @param connection The remote instance of %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
983 * @param id The %Orthanc identifier of the patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
984 **/ |
540 | 985 inline Patient::Patient(::OrthancClient::OrthancConnection& connection, const ::std::string& id) |
986 { | |
987 isReference_ = false; | |
988 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*); | |
989 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(12); | |
990 char* error = function(&pimpl_, connection.pimpl_, id.c_str()); | |
991 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
992 } | |
993 /** | |
994 * @brief Destructs the object. | |
995 * | |
996 * Destructs the object. | |
997 * | |
998 **/ | |
999 inline Patient::~Patient() | |
1000 { | |
1001 if (isReference_) return; | |
1002 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
1003 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(13); | |
1004 char* error = function(pimpl_); | |
1005 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1006 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1007 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1008 * @brief Reload the studies of this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1009 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1010 * 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
|
1011 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1012 **/ |
540 | 1013 inline void Patient::Reload() |
1014 { | |
1015 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
1016 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(14); | |
1017 char* error = function(pimpl_); | |
1018 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1019 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1020 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1021 * @brief Return the number of studies for this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1022 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1023 * Return the number of studies for this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1024 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1025 * @return The number of studies. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1026 **/ |
540 | 1027 inline LAAW_UINT32 Patient::GetStudyCount() |
1028 { | |
1029 LAAW_UINT32 result_; | |
1030 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
1031 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(15); | |
1032 char* error = function(pimpl_, &result_); | |
1033 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1034 return result_; | |
1035 } | |
593
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 * @brief Get some study of 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 * 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
|
1040 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1041 * @param index The index of the study of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1042 * @return The study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1043 **/ |
540 | 1044 inline ::OrthancClient::Study Patient::GetStudy(LAAW_UINT32 index) |
1045 { | |
1046 void* result_; | |
1047 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32); | |
1048 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(16); | |
1049 char* error = function(pimpl_, &result_, index); | |
1050 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1051 return ::OrthancClient::Study(result_); | |
1052 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1053 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1054 * @brief Get the %Orthanc identifier of this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1055 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1056 * Get the %Orthanc identifier of this patient. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1057 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1058 * @return The identifier. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1059 **/ |
540 | 1060 inline ::std::string Patient::GetId() const |
1061 { | |
1062 const char* result_; | |
1063 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
1064 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(17); | |
1065 char* error = function(pimpl_, &result_); | |
1066 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1067 return std::string(result_); | |
1068 } | |
593
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 * @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
|
1071 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1072 * 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
|
1073 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1074 * @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
|
1075 * @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
|
1076 * @return The value of the tag. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1077 **/ |
540 | 1078 inline ::std::string Patient::GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const |
1079 { | |
1080 const char* result_; | |
1081 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*, const char*); | |
1082 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(18); | |
1083 char* error = function(pimpl_, &result_, tag.c_str(), defaultValue.c_str()); | |
1084 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1085 return std::string(result_); | |
1086 } | |
1087 } | |
1088 | |
1089 namespace OrthancClient | |
1090 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1091 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1092 * @brief Create a connection to some series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1093 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1094 * Create a connection to some series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1095 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1096 * @param connection The remote instance of %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1097 * @param id The %Orthanc identifier of the series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1098 **/ |
540 | 1099 inline Series::Series(::OrthancClient::OrthancConnection& connection, const ::std::string& id) |
1100 { | |
1101 isReference_ = false; | |
1102 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*); | |
1103 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(19); | |
1104 char* error = function(&pimpl_, connection.pimpl_, id.c_str()); | |
1105 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1106 } | |
1107 /** | |
1108 * @brief Destructs the object. | |
1109 * | |
1110 * Destructs the object. | |
1111 * | |
1112 **/ | |
1113 inline Series::~Series() | |
1114 { | |
1115 if (isReference_) return; | |
1116 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
1117 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(20); | |
1118 char* error = function(pimpl_); | |
1119 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1120 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1121 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1122 * @brief Reload the instances of this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1123 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1124 * 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
|
1125 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1126 **/ |
540 | 1127 inline void Series::Reload() |
1128 { | |
1129 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
1130 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(21); | |
1131 char* error = function(pimpl_); | |
1132 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1133 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1134 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1135 * @brief Return the number of instances for this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1136 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1137 * Return the number of instances for this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1138 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1139 * @return The number of instances. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1140 **/ |
540 | 1141 inline LAAW_UINT32 Series::GetInstanceCount() |
1142 { | |
1143 LAAW_UINT32 result_; | |
1144 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
|
1145 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(22); |
540 | 1146 char* error = function(pimpl_, &result_); |
1147 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1148 return result_; | |
1149 } | |
593
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 * @brief Get some instance of 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 * 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
|
1154 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1155 * @param index The index of the instance of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1156 * @return The instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1157 **/ |
540 | 1158 inline ::OrthancClient::Instance Series::GetInstance(LAAW_UINT32 index) |
1159 { | |
1160 void* result_; | |
1161 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
|
1162 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(23); |
540 | 1163 char* error = function(pimpl_, &result_, index); |
1164 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1165 return ::OrthancClient::Instance(result_); | |
1166 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1167 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1168 * @brief Get the %Orthanc identifier of this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1169 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1170 * Get the %Orthanc identifier of this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1171 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1172 * @return The identifier. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1173 **/ |
540 | 1174 inline ::std::string Series::GetId() const |
1175 { | |
1176 const char* result_; | |
1177 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
|
1178 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(24); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1179 char* error = function(pimpl_, &result_); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1180 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1181 return std::string(result_); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1182 } |
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 * @brief Returns the URL to 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 * Returns the URL to this series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1187 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1188 * @return The URL. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1189 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1190 inline ::std::string Series::GetUrl() const |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1191 { |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1192 const char* result_; |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1193 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); |
540 | 1194 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(25); |
1195 char* error = function(pimpl_, &result_); | |
1196 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1197 return std::string(result_); | |
1198 } | |
593
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 * @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
|
1201 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1202 * 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
|
1203 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1204 * @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
|
1205 * @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
|
1206 * @return The value of the tag. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1207 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1208 inline ::std::string Series::GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const |
540 | 1209 { |
1210 const char* result_; | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1211 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*, const char*); |
540 | 1212 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(26); |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1213 char* error = function(pimpl_, &result_, tag.c_str(), defaultValue.c_str()); |
540 | 1214 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
1215 return std::string(result_); | |
1216 } | |
593
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 * @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
|
1219 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1220 * 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
|
1221 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1222 * @return "true" if and only if this is a 3D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1223 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1224 inline bool Series::Is3DImage() |
540 | 1225 { |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1226 LAAW_INT32 result_; |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1227 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_INT32*); |
540 | 1228 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(27); |
1229 char* error = function(pimpl_, &result_); | |
1230 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1231 return result_ != 0; |
540 | 1232 } |
593
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 * @brief Get the width of the 3D image. |
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 * 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
|
1237 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1238 * @return The width. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1239 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1240 inline LAAW_UINT32 Series::GetWidth() |
540 | 1241 { |
1242 LAAW_UINT32 result_; | |
1243 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
1244 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(28); | |
1245 char* error = function(pimpl_, &result_); | |
1246 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1247 return result_; | |
1248 } | |
593
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 * @brief Get the height of the 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 * 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
|
1253 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1254 * @return The height. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1255 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1256 inline LAAW_UINT32 Series::GetHeight() |
540 | 1257 { |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1258 LAAW_UINT32 result_; |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1259 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); |
540 | 1260 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(29); |
1261 char* error = function(pimpl_, &result_); | |
1262 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1263 return result_; | |
1264 } | |
593
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 * @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
|
1267 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1268 * 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
|
1269 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1270 * @return The voxel size. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1271 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1272 inline float Series::GetVoxelSizeX() |
540 | 1273 { |
1274 float result_; | |
1275 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*); | |
1276 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(30); | |
1277 char* error = function(pimpl_, &result_); | |
1278 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1279 return result_; | |
1280 } | |
593
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 * @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
|
1283 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1284 * 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
|
1285 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1286 * @return The voxel size. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1287 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1288 inline float Series::GetVoxelSizeY() |
540 | 1289 { |
1290 float result_; | |
1291 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*); | |
1292 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(31); | |
1293 char* error = function(pimpl_, &result_); | |
1294 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1295 return result_; | |
1296 } | |
593
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 * @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
|
1299 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1300 * 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
|
1301 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1302 * @return The voxel size. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1303 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1304 inline float Series::GetVoxelSizeZ() |
540 | 1305 { |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1306 float result_; |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1307 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*); |
540 | 1308 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(32); |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1309 char* error = function(pimpl_, &result_); |
540 | 1310 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1311 return result_; |
540 | 1312 } |
593
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 * @brief Load the 3D image into a memory buffer. |
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 * 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
|
1317 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1318 * @param target The target memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1319 * @param format The memory layout of the voxels. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1320 * @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
|
1321 * @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
|
1322 **/ |
540 | 1323 inline void Series::Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride) |
1324 { | |
1325 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void*, LAAW_INT32, LAAW_INT64, LAAW_INT64); | |
1326 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(33); | |
1327 char* error = function(pimpl_, target, format, lineStride, stackStride); | |
1328 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1329 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1330 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1331 * @brief Load the 3D image into a memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1332 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1333 * 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
|
1334 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1335 * @param target The target memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1336 * @param format The memory layout of the voxels. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1337 * @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
|
1338 * @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
|
1339 * @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
|
1340 **/ |
548 | 1341 inline void Series::Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride, float progress[]) |
1342 { | |
1343 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void*, LAAW_INT32, LAAW_INT64, LAAW_INT64, float*); | |
1344 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(34); | |
1345 char* error = function(pimpl_, target, format, lineStride, stackStride, progress); | |
1346 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1347 } | |
540 | 1348 } |
1349 | |
1350 namespace OrthancClient | |
1351 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1352 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1353 * @brief Create a connection to some study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1354 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1355 * Create a connection to some study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1356 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1357 * @param connection The remote instance of %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1358 * @param id The %Orthanc identifier of the study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1359 **/ |
540 | 1360 inline Study::Study(::OrthancClient::OrthancConnection& connection, const ::std::string& id) |
1361 { | |
1362 isReference_ = false; | |
1363 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*); | |
548 | 1364 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(35); |
540 | 1365 char* error = function(&pimpl_, connection.pimpl_, id.c_str()); |
1366 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1367 } | |
1368 /** | |
1369 * @brief Destructs the object. | |
1370 * | |
1371 * Destructs the object. | |
1372 * | |
1373 **/ | |
1374 inline Study::~Study() | |
1375 { | |
1376 if (isReference_) return; | |
1377 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
548 | 1378 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(36); |
540 | 1379 char* error = function(pimpl_); |
1380 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
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 Reload the series of this 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 * 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
|
1386 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1387 **/ |
540 | 1388 inline void Study::Reload() |
1389 { | |
1390 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
548 | 1391 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(37); |
540 | 1392 char* error = function(pimpl_); |
1393 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1394 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1395 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1396 * @brief Return the number of series for this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1397 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1398 * Return the number of series for this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1399 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1400 * @return The number of series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1401 **/ |
540 | 1402 inline LAAW_UINT32 Study::GetSeriesCount() |
1403 { | |
1404 LAAW_UINT32 result_; | |
1405 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
548 | 1406 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(38); |
540 | 1407 char* error = function(pimpl_, &result_); |
1408 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1409 return result_; | |
1410 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1411 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1412 * @brief Get some series of this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1413 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1414 * 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
|
1415 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1416 * @param index The index of the series of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1417 * @return The series. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1418 **/ |
540 | 1419 inline ::OrthancClient::Series Study::GetSeries(LAAW_UINT32 index) |
1420 { | |
1421 void* result_; | |
1422 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32); | |
548 | 1423 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(39); |
540 | 1424 char* error = function(pimpl_, &result_, index); |
1425 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1426 return ::OrthancClient::Series(result_); | |
1427 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1428 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1429 * @brief Get the %Orthanc identifier of this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1430 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1431 * Get the %Orthanc identifier of this study. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1432 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1433 * @return The identifier. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1434 **/ |
540 | 1435 inline ::std::string Study::GetId() const |
1436 { | |
1437 const char* result_; | |
1438 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
548 | 1439 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(40); |
540 | 1440 char* error = function(pimpl_, &result_); |
1441 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1442 return std::string(result_); | |
1443 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1444 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1445 * @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
|
1446 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1447 * 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
|
1448 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1449 * @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
|
1450 * @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
|
1451 * @return The value of the tag. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1452 **/ |
540 | 1453 inline ::std::string Study::GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const |
1454 { | |
1455 const char* result_; | |
1456 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*, const char*); | |
548 | 1457 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(41); |
540 | 1458 char* error = function(pimpl_, &result_, tag.c_str(), defaultValue.c_str()); |
1459 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1460 return std::string(result_); | |
1461 } | |
1462 } | |
1463 | |
1464 namespace OrthancClient | |
1465 { | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1466 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1467 * @brief Create a connection to some image instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1468 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1469 * Create a connection to some image instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1470 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1471 * @param connection The remote instance of %Orthanc. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1472 * @param id The %Orthanc identifier of the image instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1473 **/ |
540 | 1474 inline Instance::Instance(::OrthancClient::OrthancConnection& connection, const ::std::string& id) |
1475 { | |
1476 isReference_ = false; | |
1477 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*); | |
548 | 1478 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(42); |
540 | 1479 char* error = function(&pimpl_, connection.pimpl_, id.c_str()); |
1480 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1481 } | |
1482 /** | |
1483 * @brief Destructs the object. | |
1484 * | |
1485 * Destructs the object. | |
1486 * | |
1487 **/ | |
1488 inline Instance::~Instance() | |
1489 { | |
1490 if (isReference_) return; | |
1491 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
548 | 1492 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(43); |
540 | 1493 char* error = function(pimpl_); |
1494 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
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 Get the %Orthanc identifier of this identifier. |
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 * Get the %Orthanc identifier of this identifier. |
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 * @return The identifier. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1502 **/ |
540 | 1503 inline ::std::string Instance::GetId() const |
1504 { | |
1505 const char* result_; | |
1506 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
548 | 1507 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(44); |
540 | 1508 char* error = function(pimpl_, &result_); |
1509 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1510 return std::string(result_); | |
1511 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1512 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1513 * @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
|
1514 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1515 * 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
|
1516 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1517 * @param mode The extraction mode. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1518 **/ |
540 | 1519 inline void Instance::SetImageExtractionMode(::Orthanc::ImageExtractionMode mode) |
1520 { | |
1521 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_INT32); | |
548 | 1522 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(45); |
540 | 1523 char* error = function(pimpl_, mode); |
1524 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
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 extraction mode for the 2D image corresponding to this instance. |
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 extraction mode for the 2D image corresponding to this instance. |
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 extraction mode. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1532 **/ |
540 | 1533 inline ::Orthanc::ImageExtractionMode Instance::GetImageExtractionMode() const |
1534 { | |
1535 LAAW_INT32 result_; | |
1536 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, LAAW_INT32*); | |
548 | 1537 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(46); |
540 | 1538 char* error = function(pimpl_, &result_); |
1539 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1540 return static_cast< ::Orthanc::ImageExtractionMode >(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 Get the string value of some DICOM tag of 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 * Get the string value of some DICOM tag of 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 tag The name of the tag of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1548 * @return The value of the tag. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1549 **/ |
540 | 1550 inline ::std::string Instance::GetTagAsString(const ::std::string& tag) const |
1551 { | |
1552 const char* result_; | |
1553 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*); | |
548 | 1554 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(47); |
540 | 1555 char* error = function(pimpl_, &result_, tag.c_str()); |
1556 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1557 return std::string(result_); | |
1558 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1559 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1560 * @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
|
1561 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1562 * 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
|
1563 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1564 * @param tag The name of the tag of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1565 * @return The value of the tag. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1566 **/ |
540 | 1567 inline float Instance::GetTagAsFloat(const ::std::string& tag) const |
1568 { | |
1569 float result_; | |
1570 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, float*, const char*); | |
548 | 1571 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(48); |
540 | 1572 char* error = function(pimpl_, &result_, tag.c_str()); |
1573 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1574 return result_; | |
1575 } | |
593
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 * @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
|
1578 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1579 * 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
|
1580 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1581 * @param tag The name of the tag of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1582 * @return The value of the tag. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1583 **/ |
540 | 1584 inline LAAW_INT32 Instance::GetTagAsInt(const ::std::string& tag) const |
1585 { | |
1586 LAAW_INT32 result_; | |
1587 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, LAAW_INT32*, const char*); | |
548 | 1588 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(49); |
540 | 1589 char* error = function(pimpl_, &result_, tag.c_str()); |
1590 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1591 return result_; | |
1592 } | |
593
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 * @brief Get the width of the 2D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1595 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1596 * 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
|
1597 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1598 * @return The width. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1599 **/ |
540 | 1600 inline LAAW_UINT32 Instance::GetWidth() |
1601 { | |
1602 LAAW_UINT32 result_; | |
1603 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
548 | 1604 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(50); |
540 | 1605 char* error = function(pimpl_, &result_); |
1606 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1607 return result_; | |
1608 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1609 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1610 * @brief Get the height of the 2D image. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1611 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1612 * 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
|
1613 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1614 * @return The height. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1615 **/ |
540 | 1616 inline LAAW_UINT32 Instance::GetHeight() |
1617 { | |
1618 LAAW_UINT32 result_; | |
1619 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
548 | 1620 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(51); |
540 | 1621 char* error = function(pimpl_, &result_); |
1622 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1623 return result_; | |
1624 } | |
593
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 * @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
|
1627 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1628 * 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
|
1629 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1630 * @return The pitch. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1631 **/ |
540 | 1632 inline LAAW_UINT32 Instance::GetPitch() |
1633 { | |
1634 LAAW_UINT32 result_; | |
1635 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
548 | 1636 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(52); |
540 | 1637 char* error = function(pimpl_, &result_); |
1638 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1639 return result_; | |
1640 } | |
593
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 * @brief Get the format of the pixels of the 2D image. |
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 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
|
1645 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1646 * @return The pixel format. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1647 **/ |
540 | 1648 inline ::Orthanc::PixelFormat Instance::GetPixelFormat() |
1649 { | |
1650 LAAW_INT32 result_; | |
1651 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_INT32*); | |
548 | 1652 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(53); |
540 | 1653 char* error = function(pimpl_, &result_); |
1654 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1655 return static_cast< ::Orthanc::PixelFormat >(result_); | |
1656 } | |
593
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 * @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
|
1659 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1660 * 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
|
1661 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1662 * @return A pointer to the memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1663 **/ |
540 | 1664 inline const void* Instance::GetBuffer() |
1665 { | |
1666 const void* result_; | |
1667 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void**); | |
548 | 1668 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(54); |
540 | 1669 char* error = function(pimpl_, &result_); |
1670 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1671 return reinterpret_cast< const void* >(result_); | |
1672 } | |
593
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 * @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
|
1675 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1676 * 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
|
1677 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1678 * @param y The line of interest. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1679 * @return A pointer to the memory buffer. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1680 **/ |
540 | 1681 inline const void* Instance::GetBuffer(LAAW_UINT32 y) |
1682 { | |
1683 const void* result_; | |
1684 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void**, LAAW_UINT32); | |
548 | 1685 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(55); |
540 | 1686 char* error = function(pimpl_, &result_, y); |
1687 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1688 return reinterpret_cast< const void* >(result_); | |
1689 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1690 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1691 * @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
|
1692 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1693 * Get the size of the DICOM file corresponding to this instance. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1694 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1695 * @return The file size. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1696 **/ |
540 | 1697 inline LAAW_UINT64 Instance::GetDicomSize() |
1698 { | |
1699 LAAW_UINT64 result_; | |
1700 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT64*); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1701 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(56); |
540 | 1702 char* error = function(pimpl_, &result_); |
1703 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1704 return result_; | |
1705 } | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1706 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1707 * @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
|
1708 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1709 * 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
|
1710 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1711 * @return The DICOM file. |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1712 **/ |
540 | 1713 inline const void* Instance::GetDicom() |
1714 { | |
1715 const void* result_; | |
1716 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void**); | |
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1717 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(57); |
540 | 1718 char* error = function(pimpl_, &result_); |
1719 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
1720 return reinterpret_cast< const void* >(result_); | |
1721 } | |
593
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 * @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
|
1724 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1725 * 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
|
1726 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1727 **/ |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1728 inline void Instance::DiscardImage() |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1729 { |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1730 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1731 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(58); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1732 char* error = function(pimpl_); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1733 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1734 } |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1735 /** |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1736 * @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
|
1737 * |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1738 * 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
|
1739 * |
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 inline void Instance::DiscardDicom() |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1742 { |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1743 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1744 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(59); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1745 char* error = function(pimpl_); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1746 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1747 } |
540 | 1748 } |
1749 |