Mercurial > hg > orthanc
annotate OrthancCppClient/SharedLibrary/AUTOGENERATED/OrthancCppClient.h @ 660:f0232774b913
fix warnings
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Mon, 04 Nov 2013 15:07:58 +0100 |
| parents | 5425bb6f1ea5 |
| children | d380222b4c2a |
| rev | line source |
|---|---|
| 540 | 1 /** |
| 2 * Laaw - Lightweight, Automated API Wrapper | |
| 3 * Copyright (C) 2010-2013 Jomago - Alain Mazy, Benjamin Golinvaux, | |
| 4 * Sebastien Jodogne | |
| 5 * | |
| 6 * This program is free software: you can redistribute it and/or | |
| 7 * modify it under the terms of the GNU General Public License as | |
| 8 * published by the Free Software Foundation, either version 3 of the | |
| 9 * License, or (at your option) any later version. | |
| 10 * | |
| 11 * In addition, as a special exception, the copyright holders of this | |
| 12 * program give permission to link the code of its release with the | |
| 13 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 14 * that use the same license as the "OpenSSL" library), and distribute | |
| 15 * the linked executables. You must obey the GNU General Public License | |
| 16 * in all respects for all of the code used other than "OpenSSL". If you | |
| 17 * modify file(s) with this exception, you may extend this exception to | |
| 18 * your version of the file(s), but you are not obligated to do so. If | |
| 19 * you do not wish to do so, delete this exception statement from your | |
| 20 * version. If you delete this exception statement from all source files | |
| 21 * in the program, then also delete it here. | |
| 22 * | |
| 23 * This program is distributed in the hope that it will be useful, but | |
| 24 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 26 * General Public License for more details. | |
| 27 * | |
| 28 * You should have received a copy of the GNU General Public License | |
| 29 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 30 **/ | |
| 31 | |
| 32 | |
| 33 /** | |
| 34 * @file | |
| 35 **/ | |
| 36 | |
| 37 #pragma once | |
| 38 | |
| 39 #include <stdexcept> | |
| 40 #include <memory> | |
| 41 #include <string> | |
| 42 #include <string.h> | |
| 43 | |
| 44 #if defined(_WIN32) | |
| 45 | |
| 46 /******************************************************************** | |
| 47 ** This is the Windows-specific section | |
| 48 ********************************************************************/ | |
| 49 | |
| 50 #include <windows.h> | |
| 51 | |
| 52 /* cf. http://sourceforge.net/p/predef/wiki/Architectures/ */ | |
| 53 #ifdef _M_X64 | |
| 54 /* 64 bits target */ | |
| 55 #define LAAW_ORTHANC_CLIENT_CALL_CONV __fastcall | |
| 56 #define LAAW_ORTHANC_CLIENT_CALL_DECORATION(Name, StdCallSuffix) Name | |
| 57 #define LAAW_ORTHANC_CLIENT_DEFAULT_PATH "OrthancClient_Windows64.dll" | |
| 58 #else | |
| 59 /* 32 bits target */ | |
| 60 #define LAAW_ORTHANC_CLIENT_CALL_CONV __stdcall | |
| 61 #define LAAW_ORTHANC_CLIENT_CALL_DECORATION(Name, StdCallSuffix) "_" Name "@" StdCallSuffix | |
| 62 #define LAAW_ORTHANC_CLIENT_DEFAULT_PATH "OrthancClient_Windows32.dll" | |
| 63 #endif | |
| 64 | |
| 65 #define LAAW_ORTHANC_CLIENT_HANDLE_TYPE HINSTANCE | |
| 66 #define LAAW_ORTHANC_CLIENT_HANDLE_NULL 0 | |
| 67 #define LAAW_ORTHANC_CLIENT_FUNCTION_TYPE FARPROC | |
| 68 #define LAAW_ORTHANC_CLIENT_LOADER(path) LoadLibraryA(path) | |
| 69 #define LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle, name, decoration) GetProcAddress(handle, LAAW_ORTHANC_CLIENT_CALL_DECORATION(name, decoration)) | |
| 70 #define LAAW_ORTHANC_CLIENT_CLOSER(handle) FreeLibrary(handle) | |
| 71 | |
| 72 | |
| 73 /******************************************************************** | |
| 74 ** This is the Linux-specific section | |
| 75 ********************************************************************/ | |
| 76 | |
| 77 #elif defined (__linux) | |
| 78 | |
| 79 #include <stdlib.h> | |
| 80 #include <dlfcn.h> | |
| 81 | |
| 82 /* cf. http://sourceforge.net/p/predef/wiki/Architectures/ */ | |
| 83 #ifdef __amd64__ | |
| 629 | 84 #define LAAW_ORTHANC_CLIENT_DEFAULT_PATH "libOrthancClient.so.0.7" |
| 540 | 85 #else |
| 629 | 86 #define LAAW_ORTHANC_CLIENT_DEFAULT_PATH "libOrthancClient.so.0.7" |
| 540 | 87 #endif |
| 88 | |
| 89 #define LAAW_ORTHANC_CLIENT_CALL_CONV | |
| 90 #define LAAW_ORTHANC_CLIENT_HANDLE_TYPE void* | |
| 91 #define LAAW_ORTHANC_CLIENT_HANDLE_NULL NULL | |
| 92 #define LAAW_ORTHANC_CLIENT_FUNCTION_TYPE intptr_t | |
| 93 #define LAAW_ORTHANC_CLIENT_LOADER(path) dlopen(path, RTLD_LAZY) | |
| 94 #define LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle, name, decoration) (LAAW_ORTHANC_CLIENT_FUNCTION_TYPE) dlsym(handle, name) | |
| 95 #define LAAW_ORTHANC_CLIENT_CLOSER(handle) dlclose(handle) | |
| 96 | |
| 97 | |
| 98 #else | |
| 99 #error Please support your platform here | |
| 100 #endif | |
| 101 | |
| 102 | |
| 103 /******************************************************************** | |
| 104 ** Definition of the integer types | |
| 105 ********************************************************************/ | |
| 106 | |
| 107 #ifndef LAAW_INT8 // Only define the integer types once | |
| 108 | |
| 109 #if defined(__GNUC__) | |
| 110 | |
| 111 // Under GCC (including MinGW), the stdint.h standard header is used. | |
| 112 | |
| 113 #include <stdint.h> | |
| 114 | |
| 115 #define LAAW_INT8 int8_t | |
| 116 #define LAAW_UINT8 uint8_t | |
| 117 #define LAAW_INT16 int16_t | |
| 118 #define LAAW_UINT16 uint16_t | |
| 119 #define LAAW_INT32 int32_t | |
| 120 #define LAAW_UINT32 uint32_t | |
| 121 #define LAAW_INT64 int64_t | |
| 122 #define LAAW_UINT64 uint64_t | |
| 123 | |
| 124 #elif defined(_MSC_VER) | |
| 125 | |
| 126 // Under Visual Studio, it is required to define the various integer | |
| 127 // types by hand. | |
| 128 | |
| 129 #if (_MSC_VER < 1300) | |
| 130 typedef signed char LAAW_INT8; | |
| 131 typedef signed short LAAW_INT16; | |
| 132 typedef signed int LAAW_INT32; | |
| 133 typedef unsigned char LAAW_UINT8; | |
| 134 typedef unsigned short LAAW_UINT16; | |
| 135 typedef unsigned int LAAW_UINT32; | |
| 136 #else | |
| 137 typedef signed __int8 LAAW_INT8; | |
| 138 typedef signed __int16 LAAW_INT16; | |
| 139 typedef signed __int32 LAAW_INT32; | |
| 140 typedef unsigned __int8 LAAW_UINT8; | |
| 141 typedef unsigned __int16 LAAW_UINT16; | |
| 142 typedef unsigned __int32 LAAW_UINT32; | |
| 143 #endif | |
| 144 | |
| 145 typedef signed __int64 LAAW_INT64; | |
| 146 typedef unsigned __int64 LAAW_UINT64; | |
| 147 | |
| 148 #else | |
| 149 #error "Please support your compiler here" | |
| 150 #endif | |
| 151 | |
| 152 #endif | |
| 153 | |
| 154 | |
| 155 | |
| 156 | |
| 157 | |
| 158 /******************************************************************** | |
| 159 ** This is a shared section between Windows and Linux | |
| 160 ********************************************************************/ | |
| 161 | |
| 162 namespace OrthancClient { | |
| 163 /** | |
| 164 * @brief Exception class that is thrown by the functions of this shared library. | |
| 165 **/ | |
| 166 class OrthancClientException : public std::exception | |
| 167 { | |
| 168 private: | |
| 169 std::string message_; | |
| 170 | |
| 171 public: | |
| 172 /** | |
| 173 * @brief Constructs an exception. | |
| 174 * @param message The error message. | |
| 175 **/ | |
| 176 OrthancClientException(std::string message) : message_(message) | |
| 177 { | |
| 178 } | |
| 179 | |
| 180 ~OrthancClientException() throw() | |
| 181 { | |
| 182 } | |
| 183 | |
| 184 /** | |
| 185 * @brief Get the error message associated with this exception. | |
| 186 * @returns The error message. | |
| 187 **/ | |
| 188 const std::string& What() const throw() | |
| 189 { | |
| 190 return message_; | |
| 191 } | |
| 192 }; | |
| 193 } | |
| 194 | |
| 195 | |
| 196 namespace OrthancClient { namespace Internals { | |
| 197 /** | |
| 198 * This internal class implements a Singleton design pattern that will | |
| 199 * store a reference to the shared library handle, together with a | |
| 200 * pointer to each function in the shared library. | |
| 201 **/ | |
| 202 class Library | |
| 203 { | |
| 204 private: | |
| 205 LAAW_ORTHANC_CLIENT_HANDLE_TYPE handle_; | |
| 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 | |
| 660 | 375 namespace OrthancClient { namespace Internals { |
| 376 inline void Library::LoadFunctions() | |
| 540 | 377 { |
| 378 typedef const char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (); | |
| 379 Function getVersion = (Function) LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_GetVersion", "0"); | |
| 380 if (getVersion == NULL) | |
| 381 { | |
| 382 throw ::OrthancClient::OrthancClientException("Unable to get the library version"); | |
| 383 } | |
| 384 | |
| 385 /** | |
| 386 * It is assumed that the API does not change when the revision | |
| 387 * number (MAJOR.MINOR.REVISION) changes. | |
| 388 **/ | |
| 629 | 389 if (strcmp(getVersion(), "0.7")) |
| 540 | 390 { |
| 391 throw ::OrthancClient::OrthancClientException("Mismatch between the C++ header and the library version"); | |
| 392 } | |
| 393 | |
| 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 } | |
| 660 | 465 }} |
| 540 | 466 namespace OrthancClient |
| 467 { | |
| 468 class OrthancConnection; | |
| 469 } | |
| 470 | |
| 471 namespace OrthancClient | |
| 472 { | |
| 473 class Patient; | |
| 474 } | |
| 475 | |
| 476 namespace OrthancClient | |
| 477 { | |
| 478 class Series; | |
| 479 } | |
| 480 | |
| 481 namespace OrthancClient | |
| 482 { | |
| 483 class Study; | |
| 484 } | |
| 485 | |
| 486 namespace OrthancClient | |
| 487 { | |
| 488 class Instance; | |
| 489 } | |
| 490 | |
| 491 namespace Orthanc | |
| 492 { | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
493 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
494 * @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
|
495 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
496 * 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
|
497 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
498 * @ingroup Global |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
499 **/ |
| 540 | 500 enum PixelFormat |
| 501 { | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
502 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
503 * @brief Graylevel, signed 16bpp image. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
504 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
505 * 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
|
506 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
507 **/ |
| 540 | 508 PixelFormat_SignedGrayscale16 = 3, |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
509 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
510 * @brief Color image in RGB24 format. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
511 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
512 * Color image in RGB24 format. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
513 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
514 **/ |
| 540 | 515 PixelFormat_RGB24 = 0, |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
516 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
517 * @brief Graylevel 8bpp image. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
518 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
519 * 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
|
520 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
521 **/ |
| 540 | 522 PixelFormat_Grayscale8 = 1, |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
523 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
524 * @brief Graylevel, unsigned 16bpp image. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
525 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
526 * 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
|
527 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
528 **/ |
| 540 | 529 PixelFormat_Grayscale16 = 2 |
| 530 }; | |
| 531 } | |
| 532 | |
| 533 namespace Orthanc | |
| 534 { | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
535 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
536 * @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
|
537 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
538 * 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
|
539 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
540 * @ingroup Global |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
541 **/ |
| 540 | 542 enum ImageExtractionMode |
| 543 { | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
544 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
545 * @brief Truncation to the [-32768, 32767] range. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
546 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
547 * Truncation to the [-32768, 32767] range. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
548 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
549 **/ |
| 540 | 550 ImageExtractionMode_Int16 = 3, |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
551 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
552 * @brief Rescaled to 8bpp. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
553 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
554 * 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
|
555 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
556 **/ |
| 540 | 557 ImageExtractionMode_Preview = 0, |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
558 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
559 * @brief Truncation to the [0, 255] range. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
560 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
561 * Truncation to the [0, 255] range. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
562 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
563 **/ |
| 540 | 564 ImageExtractionMode_UInt8 = 1, |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
565 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
566 * @brief Truncation to the [0, 65535] range. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
567 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
568 * Truncation to the [0, 65535] range. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
569 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
570 **/ |
| 540 | 571 ImageExtractionMode_UInt16 = 2 |
| 572 }; | |
| 573 } | |
| 574 | |
| 575 namespace OrthancClient | |
| 576 { | |
| 573 | 577 /** |
| 578 * @brief Connection to an instance of %Orthanc. | |
| 579 * | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
580 * This class encapsulates a connection to a remote instance of %Orthanc through its REST API. |
| 573 | 581 * |
| 582 **/ | |
| 540 | 583 class OrthancConnection |
| 584 { | |
| 573 | 585 friend class ::OrthancClient::Patient; |
| 586 friend class ::OrthancClient::Series; | |
| 587 friend class ::OrthancClient::Study; | |
| 588 friend class ::OrthancClient::Instance; | |
| 540 | 589 private: |
| 590 bool isReference_; | |
| 591 | 591 OrthancConnection& operator= (const OrthancConnection&); // Assignment is forbidden |
| 540 | 592 void* pimpl_; |
| 593 OrthancConnection(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
|
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
594 public: |
| 591 | 595 /** |
| 596 * @brief Construct a new reference to this object. | |
| 597 * | |
| 598 * 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. | |
| 599 * | |
| 600 * @param other The original object. | |
| 601 **/ | |
|
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
602 OrthancConnection(const OrthancConnection& other) : isReference_(true), pimpl_(other.pimpl_) { } |
| 540 | 603 inline OrthancConnection(const ::std::string& orthancUrl); |
| 604 inline OrthancConnection(const ::std::string& orthancUrl, const ::std::string& username, const ::std::string& password); | |
| 605 inline ~OrthancConnection(); | |
| 606 inline LAAW_UINT32 GetThreadCount() const; | |
| 607 inline void SetThreadCount(LAAW_UINT32 threadCount); | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
608 inline void Reload(); |
| 540 | 609 inline ::std::string GetOrthancUrl() const; |
| 610 inline LAAW_UINT32 GetPatientCount(); | |
| 611 inline ::OrthancClient::Patient GetPatient(LAAW_UINT32 index); | |
| 612 inline void DeletePatient(LAAW_UINT32 index); | |
| 613 inline void StoreFile(const ::std::string& filename); | |
| 614 inline void Store(const void* dicom, LAAW_UINT64 size); | |
| 615 }; | |
| 616 } | |
| 617 | |
| 618 namespace OrthancClient | |
| 619 { | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
620 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
621 * @brief Connection to a patient stored in %Orthanc. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
622 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
623 * 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
|
624 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
625 **/ |
| 540 | 626 class Patient |
| 627 { | |
| 573 | 628 friend class ::OrthancClient::OrthancConnection; |
| 629 friend class ::OrthancClient::Series; | |
| 630 friend class ::OrthancClient::Study; | |
| 631 friend class ::OrthancClient::Instance; | |
| 540 | 632 private: |
| 633 bool isReference_; | |
| 591 | 634 Patient& operator= (const Patient&); // Assignment is forbidden |
| 540 | 635 void* pimpl_; |
| 636 Patient(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
|
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
637 public: |
| 591 | 638 /** |
| 639 * @brief Construct a new reference to this object. | |
| 640 * | |
| 641 * 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. | |
| 642 * | |
| 643 * @param other The original object. | |
| 644 **/ | |
|
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
645 Patient(const Patient& other) : isReference_(true), pimpl_(other.pimpl_) { } |
| 540 | 646 inline Patient(::OrthancClient::OrthancConnection& connection, const ::std::string& id); |
| 647 inline ~Patient(); | |
| 648 inline void Reload(); | |
| 649 inline LAAW_UINT32 GetStudyCount(); | |
| 650 inline ::OrthancClient::Study GetStudy(LAAW_UINT32 index); | |
| 651 inline ::std::string GetId() const; | |
| 652 inline ::std::string GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const; | |
| 653 }; | |
| 654 } | |
| 655 | |
| 656 namespace OrthancClient | |
| 657 { | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
658 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
659 * @brief Connection to a series stored in %Orthanc. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
660 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
661 * 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
|
662 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
663 **/ |
| 540 | 664 class Series |
| 665 { | |
| 573 | 666 friend class ::OrthancClient::OrthancConnection; |
| 667 friend class ::OrthancClient::Patient; | |
| 668 friend class ::OrthancClient::Study; | |
| 669 friend class ::OrthancClient::Instance; | |
| 540 | 670 private: |
| 671 bool isReference_; | |
| 591 | 672 Series& operator= (const Series&); // Assignment is forbidden |
| 540 | 673 void* pimpl_; |
| 674 Series(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
|
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
675 public: |
| 591 | 676 /** |
| 677 * @brief Construct a new reference to this object. | |
| 678 * | |
| 679 * 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. | |
| 680 * | |
| 681 * @param other The original object. | |
| 682 **/ | |
|
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
683 Series(const Series& other) : isReference_(true), pimpl_(other.pimpl_) { } |
| 540 | 684 inline Series(::OrthancClient::OrthancConnection& connection, const ::std::string& id); |
| 685 inline ~Series(); | |
| 686 inline void Reload(); | |
| 687 inline LAAW_UINT32 GetInstanceCount(); | |
| 688 inline ::OrthancClient::Instance GetInstance(LAAW_UINT32 index); | |
| 689 inline ::std::string GetId() const; | |
| 690 inline ::std::string GetUrl() const; | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
691 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
|
692 inline bool Is3DImage(); |
| 540 | 693 inline LAAW_UINT32 GetWidth(); |
| 694 inline LAAW_UINT32 GetHeight(); | |
| 695 inline float GetVoxelSizeX(); | |
| 696 inline float GetVoxelSizeY(); | |
| 697 inline float GetVoxelSizeZ(); | |
| 698 inline void Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride); | |
| 548 | 699 inline void Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride, float progress[]); |
| 540 | 700 }; |
| 701 } | |
| 702 | |
| 703 namespace OrthancClient | |
| 704 { | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
705 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
706 * @brief Connection to a study stored in %Orthanc. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
707 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
708 * 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
|
709 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
710 **/ |
| 540 | 711 class Study |
| 712 { | |
| 573 | 713 friend class ::OrthancClient::OrthancConnection; |
| 714 friend class ::OrthancClient::Patient; | |
| 715 friend class ::OrthancClient::Series; | |
| 716 friend class ::OrthancClient::Instance; | |
| 540 | 717 private: |
| 718 bool isReference_; | |
| 591 | 719 Study& operator= (const Study&); // Assignment is forbidden |
| 540 | 720 void* pimpl_; |
| 721 Study(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
|
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
722 public: |
| 591 | 723 /** |
| 724 * @brief Construct a new reference to this object. | |
| 725 * | |
| 726 * 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. | |
| 727 * | |
| 728 * @param other The original object. | |
| 729 **/ | |
|
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
730 Study(const Study& other) : isReference_(true), pimpl_(other.pimpl_) { } |
| 540 | 731 inline Study(::OrthancClient::OrthancConnection& connection, const ::std::string& id); |
| 732 inline ~Study(); | |
| 733 inline void Reload(); | |
| 734 inline LAAW_UINT32 GetSeriesCount(); | |
| 735 inline ::OrthancClient::Series GetSeries(LAAW_UINT32 index); | |
| 736 inline ::std::string GetId() const; | |
| 737 inline ::std::string GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const; | |
| 738 }; | |
| 739 } | |
| 740 | |
| 741 namespace OrthancClient | |
| 742 { | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
743 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
744 * @brief Connection to an instance stored in %Orthanc. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
745 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
746 * 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
|
747 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
748 **/ |
| 540 | 749 class Instance |
| 750 { | |
| 573 | 751 friend class ::OrthancClient::OrthancConnection; |
| 752 friend class ::OrthancClient::Patient; | |
| 753 friend class ::OrthancClient::Series; | |
| 754 friend class ::OrthancClient::Study; | |
| 540 | 755 private: |
| 756 bool isReference_; | |
| 591 | 757 Instance& operator= (const Instance&); // Assignment is forbidden |
| 540 | 758 void* pimpl_; |
| 759 Instance(void* pimpl) : isReference_(true), pimpl_(pimpl) {} | |
|
588
a0001c222b32
refactoring of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
575
diff
changeset
|
760 public: |
| 591 | 761 /** |
| 762 * @brief Construct a new reference to this object. | |
| 763 * | |
| 764 * 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. | |
| 765 * | |
| 766 * @param other The original object. | |
| 767 **/ | |
|
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
768 Instance(const Instance& other) : isReference_(true), pimpl_(other.pimpl_) { } |
| 540 | 769 inline Instance(::OrthancClient::OrthancConnection& connection, const ::std::string& id); |
| 770 inline ~Instance(); | |
| 771 inline ::std::string GetId() const; | |
| 772 inline void SetImageExtractionMode(::Orthanc::ImageExtractionMode mode); | |
| 773 inline ::Orthanc::ImageExtractionMode GetImageExtractionMode() const; | |
| 774 inline ::std::string GetTagAsString(const ::std::string& tag) const; | |
| 775 inline float GetTagAsFloat(const ::std::string& tag) const; | |
| 776 inline LAAW_INT32 GetTagAsInt(const ::std::string& tag) const; | |
| 777 inline LAAW_UINT32 GetWidth(); | |
| 778 inline LAAW_UINT32 GetHeight(); | |
| 779 inline LAAW_UINT32 GetPitch(); | |
| 780 inline ::Orthanc::PixelFormat GetPixelFormat(); | |
| 781 inline const void* GetBuffer(); | |
| 782 inline const void* GetBuffer(LAAW_UINT32 y); | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
783 inline LAAW_UINT64 GetDicomSize(); |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
784 inline const void* GetDicom(); |
| 540 | 785 inline void DiscardImage(); |
| 786 inline void DiscardDicom(); | |
| 787 }; | |
| 788 } | |
| 789 | |
| 790 namespace OrthancClient | |
| 791 { | |
| 573 | 792 /** |
| 793 * @brief Create a connection to an instance of %Orthanc. | |
| 794 * | |
| 795 * Create a connection to an instance of %Orthanc. | |
| 796 * | |
| 797 * @param orthancUrl URL to which the REST API of %Orthanc is listening. | |
| 798 **/ | |
| 540 | 799 inline OrthancConnection::OrthancConnection(const ::std::string& orthancUrl) |
| 800 { | |
| 801 isReference_ = false; | |
| 802 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, const char*); | |
| 803 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(0); | |
| 804 char* error = function(&pimpl_, orthancUrl.c_str()); | |
| 805 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 806 } | |
| 573 | 807 /** |
| 808 * @brief Create a connection to an instance of %Orthanc, with authentication. | |
| 809 * | |
| 810 * Create a connection to an instance of %Orthanc, with authentication. | |
| 811 * | |
| 812 * @param orthancUrl URL to which the REST API of %Orthanc is listening. | |
| 813 * @param username The username. | |
| 814 * @param password The password. | |
| 815 **/ | |
| 540 | 816 inline OrthancConnection::OrthancConnection(const ::std::string& orthancUrl, const ::std::string& username, const ::std::string& password) |
| 817 { | |
| 818 isReference_ = false; | |
| 819 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, const char*, const char*, const char*); | |
| 820 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(1); | |
| 821 char* error = function(&pimpl_, orthancUrl.c_str(), username.c_str(), password.c_str()); | |
| 822 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 823 } | |
| 824 /** | |
| 825 * @brief Destructs the object. | |
| 826 * | |
| 827 * Destructs the object. | |
| 828 * | |
| 829 **/ | |
| 830 inline OrthancConnection::~OrthancConnection() | |
| 831 { | |
| 832 if (isReference_) return; | |
| 833 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
| 834 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(2); | |
| 835 char* error = function(pimpl_); | |
|
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
836 error = error; // Remove warning about unused variable |
| 540 | 837 } |
| 573 | 838 /** |
| 839 * @brief Returns the number of threads for this connection. | |
| 840 * | |
| 841 * Returns the number of simultaneous connections that are used when downloading information from this instance of %Orthanc. | |
| 842 * | |
| 843 * @return The number of threads. | |
| 844 **/ | |
| 540 | 845 inline LAAW_UINT32 OrthancConnection::GetThreadCount() const |
| 846 { | |
| 847 LAAW_UINT32 result_; | |
| 848 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, LAAW_UINT32*); | |
| 849 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(3); | |
| 850 char* error = function(pimpl_, &result_); | |
| 851 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 852 return result_; | |
| 853 } | |
| 573 | 854 /** |
| 855 * @brief Sets the number of threads for this connection. | |
| 856 * | |
| 857 * Sets the number of simultaneous connections that are used when downloading information from this instance of %Orthanc. | |
| 858 * | |
| 859 * @param threadCount The number of threads. | |
| 860 **/ | |
| 540 | 861 inline void OrthancConnection::SetThreadCount(LAAW_UINT32 threadCount) |
| 862 { | |
| 863 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32); | |
| 864 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(4); | |
| 865 char* error = function(pimpl_, threadCount); | |
| 866 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 867 } | |
| 573 | 868 /** |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
869 * @brief Reload the list of the patients. |
| 573 | 870 * |
| 871 * 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. | |
| 872 * | |
| 873 **/ | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
874 inline void OrthancConnection::Reload() |
| 540 | 875 { |
| 876 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
| 877 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(5); | |
| 878 char* error = function(pimpl_); | |
| 879 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 880 } | |
| 573 | 881 /** |
| 882 * @brief Returns the URL of this instance of %Orthanc. | |
| 883 * | |
| 884 * Returns the URL of the remote %Orthanc instance to which this object is connected. | |
| 885 * | |
| 886 * @return The URL. | |
| 887 **/ | |
| 540 | 888 inline ::std::string OrthancConnection::GetOrthancUrl() const |
| 889 { | |
| 890 const char* result_; | |
| 891 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
| 892 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(6); | |
| 893 char* error = function(pimpl_, &result_); | |
| 894 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 895 return std::string(result_); | |
| 896 } | |
| 573 | 897 /** |
| 898 * @brief Returns the number of patients. | |
| 899 * | |
| 900 * Returns the number of patients that are stored in the remote instance of %Orthanc. | |
| 901 * | |
| 902 * @return The number of patients. | |
| 903 **/ | |
| 540 | 904 inline LAAW_UINT32 OrthancConnection::GetPatientCount() |
| 905 { | |
| 906 LAAW_UINT32 result_; | |
| 907 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
| 908 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(7); | |
| 909 char* error = function(pimpl_, &result_); | |
| 910 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 911 return result_; | |
| 912 } | |
| 573 | 913 /** |
| 914 * @brief Get some patient. | |
| 915 * | |
| 916 * 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). | |
| 917 * | |
| 918 * @param index The index of the patient of interest. | |
| 919 * @return The patient. | |
| 920 **/ | |
| 540 | 921 inline ::OrthancClient::Patient OrthancConnection::GetPatient(LAAW_UINT32 index) |
| 922 { | |
| 923 void* result_; | |
| 924 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32); | |
| 925 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(8); | |
| 926 char* error = function(pimpl_, &result_, index); | |
| 927 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 928 return ::OrthancClient::Patient(result_); | |
| 929 } | |
| 573 | 930 /** |
| 931 * @brief Delete some patient. | |
| 932 * | |
| 933 * 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. | |
| 934 * | |
| 935 * @param index The index of the patient of interest. | |
| 936 * @return The patient. | |
| 937 **/ | |
| 540 | 938 inline void OrthancConnection::DeletePatient(LAAW_UINT32 index) |
| 939 { | |
| 940 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32); | |
| 941 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(9); | |
| 942 char* error = function(pimpl_, index); | |
| 943 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 944 } | |
| 573 | 945 /** |
| 946 * @brief Send a DICOM file. | |
| 947 * | |
| 948 * 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. | |
| 949 * | |
| 950 * @param filename Path to the DICOM file | |
| 951 **/ | |
| 540 | 952 inline void OrthancConnection::StoreFile(const ::std::string& filename) |
| 953 { | |
| 954 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const char*); | |
| 955 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(10); | |
| 956 char* error = function(pimpl_, filename.c_str()); | |
| 957 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 958 } | |
| 573 | 959 /** |
| 960 * @brief Send a DICOM file that is contained inside a memory buffer. | |
| 961 * | |
| 962 * 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. | |
| 963 * | |
| 964 * @param dicom The memory buffer containing the DICOM file. | |
| 965 * @param size The size of the DICOM file. | |
| 966 **/ | |
| 540 | 967 inline void OrthancConnection::Store(const void* dicom, LAAW_UINT64 size) |
| 968 { | |
| 969 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void*, LAAW_UINT64); | |
| 970 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(11); | |
| 971 char* error = function(pimpl_, dicom, size); | |
| 972 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 973 } | |
| 974 } | |
| 975 | |
| 976 namespace OrthancClient | |
| 977 { | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
978 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
979 * @brief Create a connection to some patient. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
980 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
981 * Create a connection to some patient. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
982 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
983 * @param connection The remote instance of %Orthanc. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
984 * @param id The %Orthanc identifier of the patient. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
985 **/ |
| 540 | 986 inline Patient::Patient(::OrthancClient::OrthancConnection& connection, const ::std::string& id) |
| 987 { | |
| 988 isReference_ = false; | |
| 989 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*); | |
| 990 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(12); | |
| 991 char* error = function(&pimpl_, connection.pimpl_, id.c_str()); | |
| 992 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 993 } | |
| 994 /** | |
| 995 * @brief Destructs the object. | |
| 996 * | |
| 997 * Destructs the object. | |
| 998 * | |
| 999 **/ | |
| 1000 inline Patient::~Patient() | |
| 1001 { | |
| 1002 if (isReference_) return; | |
| 1003 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
| 1004 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(13); | |
| 1005 char* error = function(pimpl_); | |
|
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
1006 error = error; // Remove warning about unused variable |
| 540 | 1007 } |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1008 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1009 * @brief Reload the studies of this patient. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1010 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1011 * 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
|
1012 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1013 **/ |
| 540 | 1014 inline void Patient::Reload() |
| 1015 { | |
| 1016 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
| 1017 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(14); | |
| 1018 char* error = function(pimpl_); | |
| 1019 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1020 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1021 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1022 * @brief Return the number of studies for this patient. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1023 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1024 * Return the number of studies for this patient. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1025 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1026 * @return The number of studies. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1027 **/ |
| 540 | 1028 inline LAAW_UINT32 Patient::GetStudyCount() |
| 1029 { | |
| 1030 LAAW_UINT32 result_; | |
| 1031 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
| 1032 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(15); | |
| 1033 char* error = function(pimpl_, &result_); | |
| 1034 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1035 return result_; | |
| 1036 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1037 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1038 * @brief Get some study of this patient. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1039 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1040 * 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
|
1041 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1042 * @param index The index of the study of interest. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1043 * @return The study. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1044 **/ |
| 540 | 1045 inline ::OrthancClient::Study Patient::GetStudy(LAAW_UINT32 index) |
| 1046 { | |
| 1047 void* result_; | |
| 1048 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32); | |
| 1049 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(16); | |
| 1050 char* error = function(pimpl_, &result_, index); | |
| 1051 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1052 return ::OrthancClient::Study(result_); | |
| 1053 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1054 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1055 * @brief Get the %Orthanc identifier of this patient. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1056 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1057 * Get the %Orthanc identifier of this patient. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1058 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1059 * @return The identifier. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1060 **/ |
| 540 | 1061 inline ::std::string Patient::GetId() const |
| 1062 { | |
| 1063 const char* result_; | |
| 1064 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
| 1065 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(17); | |
| 1066 char* error = function(pimpl_, &result_); | |
| 1067 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1068 return std::string(result_); | |
| 1069 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1070 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1071 * @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
|
1072 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1073 * 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
|
1074 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1075 * @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
|
1076 * @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
|
1077 * @return The value of the tag. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1078 **/ |
| 540 | 1079 inline ::std::string Patient::GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const |
| 1080 { | |
| 1081 const char* result_; | |
| 1082 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*, const char*); | |
| 1083 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(18); | |
| 1084 char* error = function(pimpl_, &result_, tag.c_str(), defaultValue.c_str()); | |
| 1085 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1086 return std::string(result_); | |
| 1087 } | |
| 1088 } | |
| 1089 | |
| 1090 namespace OrthancClient | |
| 1091 { | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1092 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1093 * @brief Create a connection to some series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1094 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1095 * Create a connection to some series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1096 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1097 * @param connection The remote instance of %Orthanc. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1098 * @param id The %Orthanc identifier of the series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1099 **/ |
| 540 | 1100 inline Series::Series(::OrthancClient::OrthancConnection& connection, const ::std::string& id) |
| 1101 { | |
| 1102 isReference_ = false; | |
| 1103 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*); | |
| 1104 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(19); | |
| 1105 char* error = function(&pimpl_, connection.pimpl_, id.c_str()); | |
| 1106 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1107 } | |
| 1108 /** | |
| 1109 * @brief Destructs the object. | |
| 1110 * | |
| 1111 * Destructs the object. | |
| 1112 * | |
| 1113 **/ | |
| 1114 inline Series::~Series() | |
| 1115 { | |
| 1116 if (isReference_) return; | |
| 1117 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
| 1118 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(20); | |
| 1119 char* error = function(pimpl_); | |
|
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
1120 error = error; // Remove warning about unused variable |
| 540 | 1121 } |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1122 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1123 * @brief Reload the instances of this series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1124 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1125 * 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
|
1126 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1127 **/ |
| 540 | 1128 inline void Series::Reload() |
| 1129 { | |
| 1130 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
| 1131 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(21); | |
| 1132 char* error = function(pimpl_); | |
| 1133 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1134 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1135 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1136 * @brief Return the number of instances for this series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1137 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1138 * Return the number of instances for this series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1139 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1140 * @return The number of instances. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1141 **/ |
| 540 | 1142 inline LAAW_UINT32 Series::GetInstanceCount() |
| 1143 { | |
| 1144 LAAW_UINT32 result_; | |
| 1145 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
|
1146 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(22); |
| 540 | 1147 char* error = function(pimpl_, &result_); |
| 1148 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1149 return result_; | |
| 1150 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1151 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1152 * @brief Get some instance of this series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1153 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1154 * 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
|
1155 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1156 * @param index The index of the instance of interest. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1157 * @return The instance. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1158 **/ |
| 540 | 1159 inline ::OrthancClient::Instance Series::GetInstance(LAAW_UINT32 index) |
| 1160 { | |
| 1161 void* result_; | |
| 1162 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
|
1163 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(23); |
| 540 | 1164 char* error = function(pimpl_, &result_, index); |
| 1165 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1166 return ::OrthancClient::Instance(result_); | |
| 1167 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1168 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1169 * @brief Get the %Orthanc identifier of this series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1170 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1171 * Get the %Orthanc identifier of this series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1172 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1173 * @return The identifier. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1174 **/ |
| 540 | 1175 inline ::std::string Series::GetId() const |
| 1176 { | |
| 1177 const char* result_; | |
| 1178 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
|
1179 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(24); |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1180 char* error = function(pimpl_, &result_); |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1181 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1182 return std::string(result_); |
|
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 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1185 * @brief Returns the URL to this series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1186 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1187 * Returns the URL to this series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1188 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1189 * @return The URL. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1190 **/ |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1191 inline ::std::string Series::GetUrl() const |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1192 { |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1193 const char* result_; |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1194 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); |
| 540 | 1195 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(25); |
| 1196 char* error = function(pimpl_, &result_); | |
| 1197 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1198 return std::string(result_); | |
| 1199 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1200 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1201 * @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
|
1202 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1203 * 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
|
1204 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1205 * @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
|
1206 * @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
|
1207 * @return The value of the tag. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1208 **/ |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1209 inline ::std::string Series::GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const |
| 540 | 1210 { |
| 1211 const char* result_; | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1212 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*, const char*); |
| 540 | 1213 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(26); |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1214 char* error = function(pimpl_, &result_, tag.c_str(), defaultValue.c_str()); |
| 540 | 1215 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
| 1216 return std::string(result_); | |
| 1217 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1218 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1219 * @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
|
1220 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1221 * 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
|
1222 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1223 * @return "true" if and only if this is a 3D image. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1224 **/ |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1225 inline bool Series::Is3DImage() |
| 540 | 1226 { |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1227 LAAW_INT32 result_; |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1228 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_INT32*); |
| 540 | 1229 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(27); |
| 1230 char* error = function(pimpl_, &result_); | |
| 1231 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1232 return result_ != 0; |
| 540 | 1233 } |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1234 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1235 * @brief Get the width of the 3D image. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1236 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1237 * 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
|
1238 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1239 * @return The width. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1240 **/ |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1241 inline LAAW_UINT32 Series::GetWidth() |
| 540 | 1242 { |
| 1243 LAAW_UINT32 result_; | |
| 1244 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
| 1245 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(28); | |
| 1246 char* error = function(pimpl_, &result_); | |
| 1247 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1248 return result_; | |
| 1249 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1250 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1251 * @brief Get the height of the 3D image. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1252 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1253 * 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
|
1254 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1255 * @return The height. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1256 **/ |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1257 inline LAAW_UINT32 Series::GetHeight() |
| 540 | 1258 { |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1259 LAAW_UINT32 result_; |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1260 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); |
| 540 | 1261 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(29); |
| 1262 char* error = function(pimpl_, &result_); | |
| 1263 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1264 return result_; | |
| 1265 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1266 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1267 * @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
|
1268 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1269 * 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
|
1270 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1271 * @return The voxel size. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1272 **/ |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1273 inline float Series::GetVoxelSizeX() |
| 540 | 1274 { |
| 1275 float result_; | |
| 1276 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*); | |
| 1277 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(30); | |
| 1278 char* error = function(pimpl_, &result_); | |
| 1279 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1280 return result_; | |
| 1281 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1282 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1283 * @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
|
1284 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1285 * 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
|
1286 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1287 * @return The voxel size. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1288 **/ |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1289 inline float Series::GetVoxelSizeY() |
| 540 | 1290 { |
| 1291 float result_; | |
| 1292 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*); | |
| 1293 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(31); | |
| 1294 char* error = function(pimpl_, &result_); | |
| 1295 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1296 return result_; | |
| 1297 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1298 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1299 * @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
|
1300 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1301 * 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
|
1302 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1303 * @return The voxel size. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1304 **/ |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1305 inline float Series::GetVoxelSizeZ() |
| 540 | 1306 { |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1307 float result_; |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1308 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*); |
| 540 | 1309 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(32); |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1310 char* error = function(pimpl_, &result_); |
| 540 | 1311 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1312 return result_; |
| 540 | 1313 } |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1314 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1315 * @brief Load the 3D image into a memory buffer. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1316 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1317 * 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
|
1318 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1319 * @param target The target memory buffer. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1320 * @param format The memory layout of the voxels. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1321 * @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
|
1322 * @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
|
1323 **/ |
| 540 | 1324 inline void Series::Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride) |
| 1325 { | |
| 1326 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void*, LAAW_INT32, LAAW_INT64, LAAW_INT64); | |
| 1327 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(33); | |
| 1328 char* error = function(pimpl_, target, format, lineStride, stackStride); | |
| 1329 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1330 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1331 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1332 * @brief Load the 3D image into a memory buffer. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1333 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1334 * 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
|
1335 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1336 * @param target The target memory buffer. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1337 * @param format The memory layout of the voxels. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1338 * @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
|
1339 * @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
|
1340 * @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
|
1341 **/ |
| 548 | 1342 inline void Series::Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride, float progress[]) |
| 1343 { | |
| 1344 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void*, LAAW_INT32, LAAW_INT64, LAAW_INT64, float*); | |
| 1345 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(34); | |
| 1346 char* error = function(pimpl_, target, format, lineStride, stackStride, progress); | |
| 1347 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1348 } | |
| 540 | 1349 } |
| 1350 | |
| 1351 namespace OrthancClient | |
| 1352 { | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1353 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1354 * @brief Create a connection to some study. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1355 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1356 * Create a connection to some study. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1357 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1358 * @param connection The remote instance of %Orthanc. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1359 * @param id The %Orthanc identifier of the study. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1360 **/ |
| 540 | 1361 inline Study::Study(::OrthancClient::OrthancConnection& connection, const ::std::string& id) |
| 1362 { | |
| 1363 isReference_ = false; | |
| 1364 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*); | |
| 548 | 1365 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(35); |
| 540 | 1366 char* error = function(&pimpl_, connection.pimpl_, id.c_str()); |
| 1367 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1368 } | |
| 1369 /** | |
| 1370 * @brief Destructs the object. | |
| 1371 * | |
| 1372 * Destructs the object. | |
| 1373 * | |
| 1374 **/ | |
| 1375 inline Study::~Study() | |
| 1376 { | |
| 1377 if (isReference_) return; | |
| 1378 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
| 548 | 1379 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(36); |
| 540 | 1380 char* error = function(pimpl_); |
|
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
1381 error = error; // Remove warning about unused variable |
| 540 | 1382 } |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1383 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1384 * @brief Reload the series of this study. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1385 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1386 * 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
|
1387 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1388 **/ |
| 540 | 1389 inline void Study::Reload() |
| 1390 { | |
| 1391 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
| 548 | 1392 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(37); |
| 540 | 1393 char* error = function(pimpl_); |
| 1394 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1395 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1396 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1397 * @brief Return the number of series for this study. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1398 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1399 * Return the number of series for this study. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1400 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1401 * @return The number of series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1402 **/ |
| 540 | 1403 inline LAAW_UINT32 Study::GetSeriesCount() |
| 1404 { | |
| 1405 LAAW_UINT32 result_; | |
| 1406 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
| 548 | 1407 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(38); |
| 540 | 1408 char* error = function(pimpl_, &result_); |
| 1409 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1410 return result_; | |
| 1411 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1412 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1413 * @brief Get some series of this study. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1414 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1415 * This method will 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
|
1416 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1417 * @param index The index of the series of interest. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1418 * @return The series. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1419 **/ |
| 540 | 1420 inline ::OrthancClient::Series Study::GetSeries(LAAW_UINT32 index) |
| 1421 { | |
| 1422 void* result_; | |
| 1423 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32); | |
| 548 | 1424 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(39); |
| 540 | 1425 char* error = function(pimpl_, &result_, index); |
| 1426 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1427 return ::OrthancClient::Series(result_); | |
| 1428 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1429 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1430 * @brief Get the %Orthanc identifier of this study. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1431 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1432 * Get the %Orthanc identifier of this study. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1433 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1434 * @return The identifier. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1435 **/ |
| 540 | 1436 inline ::std::string Study::GetId() const |
| 1437 { | |
| 1438 const char* result_; | |
| 1439 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
| 548 | 1440 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(40); |
| 540 | 1441 char* error = function(pimpl_, &result_); |
| 1442 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1443 return std::string(result_); | |
| 1444 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1445 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1446 * @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
|
1447 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1448 * 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
|
1449 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1450 * @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
|
1451 * @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
|
1452 * @return The value of the tag. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1453 **/ |
| 540 | 1454 inline ::std::string Study::GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const |
| 1455 { | |
| 1456 const char* result_; | |
| 1457 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*, const char*); | |
| 548 | 1458 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(41); |
| 540 | 1459 char* error = function(pimpl_, &result_, tag.c_str(), defaultValue.c_str()); |
| 1460 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1461 return std::string(result_); | |
| 1462 } | |
| 1463 } | |
| 1464 | |
| 1465 namespace OrthancClient | |
| 1466 { | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1467 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1468 * @brief Create a connection to some image instance. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1469 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1470 * Create a connection to some image instance. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1471 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1472 * @param connection The remote instance of %Orthanc. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1473 * @param id The %Orthanc identifier of the image instance. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1474 **/ |
| 540 | 1475 inline Instance::Instance(::OrthancClient::OrthancConnection& connection, const ::std::string& id) |
| 1476 { | |
| 1477 isReference_ = false; | |
| 1478 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*); | |
| 548 | 1479 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(42); |
| 540 | 1480 char* error = function(&pimpl_, connection.pimpl_, id.c_str()); |
| 1481 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1482 } | |
| 1483 /** | |
| 1484 * @brief Destructs the object. | |
| 1485 * | |
| 1486 * Destructs the object. | |
| 1487 * | |
| 1488 **/ | |
| 1489 inline Instance::~Instance() | |
| 1490 { | |
| 1491 if (isReference_) return; | |
| 1492 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); | |
| 548 | 1493 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(43); |
| 540 | 1494 char* error = function(pimpl_); |
|
657
5425bb6f1ea5
further cppcheck fixes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
629
diff
changeset
|
1495 error = error; // Remove warning about unused variable |
| 540 | 1496 } |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1497 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1498 * @brief Get the %Orthanc identifier of this identifier. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1499 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1500 * Get the %Orthanc identifier of this identifier. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1501 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1502 * @return The identifier. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1503 **/ |
| 540 | 1504 inline ::std::string Instance::GetId() const |
| 1505 { | |
| 1506 const char* result_; | |
| 1507 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**); | |
| 548 | 1508 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(44); |
| 540 | 1509 char* error = function(pimpl_, &result_); |
| 1510 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1511 return std::string(result_); | |
| 1512 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1513 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1514 * @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
|
1515 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1516 * 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
|
1517 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1518 * @param mode The extraction mode. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1519 **/ |
| 540 | 1520 inline void Instance::SetImageExtractionMode(::Orthanc::ImageExtractionMode mode) |
| 1521 { | |
| 1522 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_INT32); | |
| 548 | 1523 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(45); |
| 540 | 1524 char* error = function(pimpl_, mode); |
| 1525 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1526 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1527 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1528 * @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
|
1529 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1530 * 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
|
1531 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1532 * @return The extraction mode. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1533 **/ |
| 540 | 1534 inline ::Orthanc::ImageExtractionMode Instance::GetImageExtractionMode() const |
| 1535 { | |
| 1536 LAAW_INT32 result_; | |
| 1537 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, LAAW_INT32*); | |
| 548 | 1538 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(46); |
| 540 | 1539 char* error = function(pimpl_, &result_); |
| 1540 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1541 return static_cast< ::Orthanc::ImageExtractionMode >(result_); | |
| 1542 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1543 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1544 * @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
|
1545 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1546 * Get the string value of some DICOM tag of this instance. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1547 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1548 * @param tag The name of the tag of interest. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1549 * @return The value of the tag. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1550 **/ |
| 540 | 1551 inline ::std::string Instance::GetTagAsString(const ::std::string& tag) const |
| 1552 { | |
| 1553 const char* result_; | |
| 1554 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*); | |
| 548 | 1555 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(47); |
| 540 | 1556 char* error = function(pimpl_, &result_, tag.c_str()); |
| 1557 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1558 return std::string(result_); | |
| 1559 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1560 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1561 * @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
|
1562 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1563 * 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
|
1564 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1565 * @param tag The name of the tag of interest. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1566 * @return The value of the tag. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1567 **/ |
| 540 | 1568 inline float Instance::GetTagAsFloat(const ::std::string& tag) const |
| 1569 { | |
| 1570 float result_; | |
| 1571 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, float*, const char*); | |
| 548 | 1572 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(48); |
| 540 | 1573 char* error = function(pimpl_, &result_, tag.c_str()); |
| 1574 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1575 return result_; | |
| 1576 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1577 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1578 * @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
|
1579 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1580 * 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
|
1581 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1582 * @param tag The name of the tag of interest. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1583 * @return The value of the tag. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1584 **/ |
| 540 | 1585 inline LAAW_INT32 Instance::GetTagAsInt(const ::std::string& tag) const |
| 1586 { | |
| 1587 LAAW_INT32 result_; | |
| 1588 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, LAAW_INT32*, const char*); | |
| 548 | 1589 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(49); |
| 540 | 1590 char* error = function(pimpl_, &result_, tag.c_str()); |
| 1591 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1592 return result_; | |
| 1593 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1594 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1595 * @brief Get the width of the 2D image. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1596 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1597 * 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
|
1598 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1599 * @return The width. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1600 **/ |
| 540 | 1601 inline LAAW_UINT32 Instance::GetWidth() |
| 1602 { | |
| 1603 LAAW_UINT32 result_; | |
| 1604 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
| 548 | 1605 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(50); |
| 540 | 1606 char* error = function(pimpl_, &result_); |
| 1607 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1608 return result_; | |
| 1609 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1610 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1611 * @brief Get the height of the 2D image. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1612 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1613 * 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
|
1614 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1615 * @return The height. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1616 **/ |
| 540 | 1617 inline LAAW_UINT32 Instance::GetHeight() |
| 1618 { | |
| 1619 LAAW_UINT32 result_; | |
| 1620 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
| 548 | 1621 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(51); |
| 540 | 1622 char* error = function(pimpl_, &result_); |
| 1623 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1624 return result_; | |
| 1625 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1626 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1627 * @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
|
1628 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1629 * 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
|
1630 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1631 * @return The pitch. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1632 **/ |
| 540 | 1633 inline LAAW_UINT32 Instance::GetPitch() |
| 1634 { | |
| 1635 LAAW_UINT32 result_; | |
| 1636 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*); | |
| 548 | 1637 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(52); |
| 540 | 1638 char* error = function(pimpl_, &result_); |
| 1639 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1640 return result_; | |
| 1641 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1642 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1643 * @brief Get the format of the pixels of the 2D image. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1644 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1645 * 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
|
1646 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1647 * @return The pixel format. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1648 **/ |
| 540 | 1649 inline ::Orthanc::PixelFormat Instance::GetPixelFormat() |
| 1650 { | |
| 1651 LAAW_INT32 result_; | |
| 1652 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_INT32*); | |
| 548 | 1653 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(53); |
| 540 | 1654 char* error = function(pimpl_, &result_); |
| 1655 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1656 return static_cast< ::Orthanc::PixelFormat >(result_); | |
| 1657 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1658 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1659 * @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
|
1660 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1661 * 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
|
1662 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1663 * @return A pointer to the memory buffer. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1664 **/ |
| 540 | 1665 inline const void* Instance::GetBuffer() |
| 1666 { | |
| 1667 const void* result_; | |
| 1668 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void**); | |
| 548 | 1669 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(54); |
| 540 | 1670 char* error = function(pimpl_, &result_); |
| 1671 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1672 return reinterpret_cast< const void* >(result_); | |
| 1673 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1674 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1675 * @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
|
1676 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1677 * 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
|
1678 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1679 * @param y The line of interest. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1680 * @return A pointer to the memory buffer. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1681 **/ |
| 540 | 1682 inline const void* Instance::GetBuffer(LAAW_UINT32 y) |
| 1683 { | |
| 1684 const void* result_; | |
| 1685 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void**, LAAW_UINT32); | |
| 548 | 1686 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(55); |
| 540 | 1687 char* error = function(pimpl_, &result_, y); |
| 1688 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1689 return reinterpret_cast< const void* >(result_); | |
| 1690 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1691 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1692 * @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
|
1693 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1694 * Get the size of the DICOM file corresponding to this instance. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1695 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1696 * @return The file size. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1697 **/ |
| 540 | 1698 inline LAAW_UINT64 Instance::GetDicomSize() |
| 1699 { | |
| 1700 LAAW_UINT64 result_; | |
| 1701 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
|
1702 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(56); |
| 540 | 1703 char* error = function(pimpl_, &result_); |
| 1704 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1705 return result_; | |
| 1706 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1707 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1708 * @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
|
1709 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1710 * 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
|
1711 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1712 * @return The DICOM file. |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1713 **/ |
| 540 | 1714 inline const void* Instance::GetDicom() |
| 1715 { | |
| 1716 const void* result_; | |
| 1717 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
|
1718 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(57); |
| 540 | 1719 char* error = function(pimpl_, &result_); |
| 1720 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); | |
| 1721 return reinterpret_cast< const void* >(result_); | |
| 1722 } | |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1723 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1724 * @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
|
1725 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1726 * 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
|
1727 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1728 **/ |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1729 inline void Instance::DiscardImage() |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1730 { |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1731 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1732 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(58); |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1733 char* error = function(pimpl_); |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1734 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
|
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 /** |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1737 * @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
|
1738 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1739 * 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
|
1740 * |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1741 **/ |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1742 inline void Instance::DiscardDicom() |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1743 { |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1744 typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*); |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1745 Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(59); |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1746 char* error = function(pimpl_); |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1747 ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error); |
|
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
1748 } |
| 540 | 1749 } |
| 1750 |