Orthanc Client
Documentation of the client library of Orthanc
OrthancCppClient.h
Go to the documentation of this file.
1 
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__
84 #define LAAW_ORTHANC_CLIENT_DEFAULT_PATH "libOrthancClient.so.0.8"
85 #else
86 #define LAAW_ORTHANC_CLIENT_DEFAULT_PATH "libOrthancClient.so.0.8"
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 {
166 class OrthancClientException : public std::exception
167  {
168  private:
169  std::string message_;
170 
171  public:
176  OrthancClientException(std::string message) : message_(message)
177  {
178  }
179 
180  ~OrthancClientException() throw()
181  {
182  }
183 
188  const std::string& What() const throw()
189  {
190  return message_;
191  }
192 };
193 }
194 
195 
196 namespace OrthancClient { namespace Internals {
202 class Library
203  {
204  private:
205  LAAW_ORTHANC_CLIENT_HANDLE_TYPE handle_;
206  LAAW_ORTHANC_CLIENT_FUNCTION_TYPE functionsIndex_[63 + 1];
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*);
242  Function function = (Function) GetFunction(63);
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  {
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  {
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 #if 0
306 
312  LAAW_ORTHANC_CLIENT_CLOSER(handle_);
313 #endif
314  handle_ = LAAW_ORTHANC_CLIENT_HANDLE_NULL;
315  }
316  }
317 };
318 }}
319 
320 
328 namespace OrthancClient {
342 inline void Initialize()
343 {
345 }
346 
358 inline void Initialize(const std::string& sharedLibraryPath)
359 {
360  ::OrthancClient::Internals::Library::Initialize(sharedLibraryPath.c_str());
361 }
362 
371 inline void Finalize()
372 {
373  ::OrthancClient::Internals::Library::GetInstance().Finalize();
374 }
375 
376 
380 }
381 
382 
383 namespace OrthancClient { namespace Internals {
384 inline void Library::LoadFunctions()
385 {
386  typedef const char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) ();
387  Function getVersion = (Function) LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_GetVersion", "0");
388  if (getVersion == NULL)
389  {
390  throw ::OrthancClient::OrthancClientException("Unable to get the library version");
391  }
392 
397  if (strcmp(getVersion(), "0.8"))
398  {
399  throw ::OrthancClient::OrthancClientException("Mismatch between the C++ header and the library version");
400  }
401 
402  functionsIndex_[63] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_FreeString", "4");
403  functionsIndex_[3] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_557aee7b61817292a0f31269d3c35db7", "8");
404  functionsIndex_[4] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_0b8dff0ce67f10954a49b059e348837e", "8");
405  functionsIndex_[5] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_e05097c153f676e5a5ee54dcfc78256f", "4");
406  functionsIndex_[6] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_e840242bf58d17d3c1d722da09ce88e0", "8");
407  functionsIndex_[7] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_c9af31433001b5dfc012a552dc6d0050", "8");
408  functionsIndex_[8] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_3fba4d6b818180a44cd1cae6046334dc", "12");
409  functionsIndex_[9] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_aeb20dc75b9246188db857317e5e0ce7", "8");
410  functionsIndex_[10] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_62689803d9871e4d9c51a648640b320b", "8");
411  functionsIndex_[11] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_2fb64c9e5a67eccd413b0e913469a421", "16");
412  functionsIndex_[0] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_1f1acb322ea4d0aad65172824607673c", "8");
413  functionsIndex_[1] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_f3fd272e4636f6a531aabb72ee01cd5b", "16");
414  functionsIndex_[2] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_12d3de0a96e9efb11136a9811bb9ed38", "4");
415  functionsIndex_[14] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_f756172daf04516eec3a566adabb4335", "4");
416  functionsIndex_[15] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_ddb68763ec902a97d579666a73a20118", "8");
417  functionsIndex_[16] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_fba3c68b4be7558dbc65f7ce1ab57d63", "12");
418  functionsIndex_[17] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_b4ca99d958f843493e58d1ef967340e1", "8");
419  functionsIndex_[18] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_78d5cc76d282437b6f93ec3b82c35701", "16");
420  functionsIndex_[12] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_6cf0d7268667f9b0aa4511bacf184919", "12");
421  functionsIndex_[13] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_7d81cd502ee27e859735d0ea7112b5a1", "4");
422  functionsIndex_[21] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_48a2a1a9d68c047e22bfba23014643d2", "4");
423  functionsIndex_[22] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_852bf8296ca21c5fde5ec565cc10721d", "8");
424  functionsIndex_[23] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_efd04574e0779faa83df1f2d8f9888db", "12");
425  functionsIndex_[24] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_736247ff5e8036dac38163da6f666ed5", "8");
426  functionsIndex_[25] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_d82d2598a7a73f4b6fcc0c09c25b08ca", "8");
427  functionsIndex_[26] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_88134b978f9acb2aecdadf54aeab3c64", "16");
428  functionsIndex_[27] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_152cb1b704c053d24b0dab7461ba6ea3", "8");
429  functionsIndex_[28] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_eee03f337ec81d9f1783cd41e5238757", "8");
430  functionsIndex_[29] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_006f08237bd7611636fc721baebfb4c5", "8");
431  functionsIndex_[30] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_b794f5cd3dad7d7b575dd1fd902afdd0", "8");
432  functionsIndex_[31] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_8ee2e50dd9df8f66a3c1766090dd03ab", "8");
433  functionsIndex_[32] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_046aed35bbe4751691f4c34cc249a61d", "8");
434  functionsIndex_[33] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_2be452e7af5bf7dfd8c5021842674497", "8");
435  functionsIndex_[34] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_4dcc7a0fd025efba251ac6e9b701c2c5", "28");
436  functionsIndex_[35] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_b2601a161c24ad0a1d3586246f87452c", "32");
437  functionsIndex_[19] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_193599b9e345384fcdfcd47c29c55342", "12");
438  functionsIndex_[20] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_7c97f17063a357d38c5fab1136ad12a0", "4");
439  functionsIndex_[38] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_e65b20b7e0170b67544cd6664a4639b7", "4");
440  functionsIndex_[39] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_470e981b0e41f17231ba0ae6f3033321", "8");
441  functionsIndex_[40] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_04cefd138b6ea15ad909858f2a0a8f05", "12");
442  functionsIndex_[41] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_aee5b1f6f0c082f2c3b0986f9f6a18c7", "8");
443  functionsIndex_[42] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_93965682bace75491413e1f0b8d5a654", "16");
444  functionsIndex_[36] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_b01c6003238eb46c8db5dc823d7ca678", "12");
445  functionsIndex_[37] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_0147007fb99bad8cd95a139ec8795376", "4");
446  functionsIndex_[45] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_236ee8b403bc99535a8a4695c0cd45cb", "8");
447  functionsIndex_[46] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_2a437b7aba6bb01e81113835be8f0146", "8");
448  functionsIndex_[47] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_2bcbcb850934ae0bb4c6f0cc940e6cda", "8");
449  functionsIndex_[48] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_8d415c3a78a48e7e61d9fd24e7c79484", "12");
450  functionsIndex_[49] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_70d2f8398bbc63b5f792b69b4ad5fecb", "12");
451  functionsIndex_[50] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_1729a067d902771517388eedd7346b23", "12");
452  functionsIndex_[51] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_72e2aeee66cd3abd8ab7e987321c3745", "8");
453  functionsIndex_[52] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_1ea3df5a1ac1a1a687fe7325adddb6f0", "8");
454  functionsIndex_[53] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_99b4f370e4f532d8b763e2cb49db92f8", "8");
455  functionsIndex_[54] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_c41c742b68617f1c0590577a0a5ebc0c", "8");
456  functionsIndex_[55] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_142dd2feba0fc1d262bbd0baeb441a8b", "8");
457  functionsIndex_[56] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_5f5c9f81a4dff8daa6c359f1d0488fef", "12");
458  functionsIndex_[57] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_9ca979fffd08fa256306d4e68d8b0e91", "8");
459  functionsIndex_[58] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_6f2d77a26edc91c28d89408dbc3c271e", "8");
460  functionsIndex_[59] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_c0f494b80d4ff8b232df7a75baa0700a", "4");
461  functionsIndex_[60] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_d604f44bd5195e082e745e9cbc164f4c", "4");
462  functionsIndex_[61] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_1710299d1c5f3b1f2b7cf3962deebbfd", "8");
463  functionsIndex_[62] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_bb55aaf772ddceaadee36f4e54136bcb", "8");
464  functionsIndex_[43] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_6c5ad02f91b583e29cebd0bd319ce21d", "12");
465  functionsIndex_[44] = LAAW_ORTHANC_CLIENT_GET_FUNCTION(handle_, "LAAW_EXTERNC_4068241c44a9c1367fe0e57be523f207", "4");
466 
467  /* Check whether the functions were properly loaded */
468  for (unsigned int i = 0; i <= 63; i++)
469  {
470  if (functionsIndex_[i] == (LAAW_ORTHANC_CLIENT_FUNCTION_TYPE) NULL)
471  {
472  throw ::OrthancClient::OrthancClientException("Unable to load the functions of the shared library");
473  }
474  }
475 }
476 }}
477 namespace OrthancClient
478 {
479  class OrthancConnection;
480 }
481 
482 namespace OrthancClient
483 {
484  class Patient;
485 }
486 
487 namespace OrthancClient
488 {
489  class Series;
490 }
491 
492 namespace OrthancClient
493 {
494  class Study;
495 }
496 
497 namespace OrthancClient
498 {
499  class Instance;
500 }
501 
502 namespace Orthanc
503 {
512  {
548  };
549 }
550 
551 namespace Orthanc
552 {
561  {
590  };
591 }
592 
593 namespace OrthancClient
594 {
602  {
603  friend class ::OrthancClient::Patient;
604  friend class ::OrthancClient::Series;
605  friend class ::OrthancClient::Study;
606  friend class ::OrthancClient::Instance;
607  private:
608  bool isReference_;
609  OrthancConnection& operator= (const OrthancConnection&); // Assignment is forbidden
610  void* pimpl_;
611  OrthancConnection(void* pimpl) : isReference_(true), pimpl_(pimpl) {}
612  public:
620  OrthancConnection(const OrthancConnection& other) : isReference_(true), pimpl_(other.pimpl_) { }
621  inline OrthancConnection(const ::std::string& orthancUrl);
622  inline OrthancConnection(const ::std::string& orthancUrl, const ::std::string& username, const ::std::string& password);
623  inline ~OrthancConnection();
624  inline LAAW_UINT32 GetThreadCount() const;
625  inline void SetThreadCount(LAAW_UINT32 threadCount);
626  inline void Reload();
627  inline ::std::string GetOrthancUrl() const;
628  inline LAAW_UINT32 GetPatientCount();
629  inline ::OrthancClient::Patient GetPatient(LAAW_UINT32 index);
630  inline void DeletePatient(LAAW_UINT32 index);
631  inline void StoreFile(const ::std::string& filename);
632  inline void Store(const void* dicom, LAAW_UINT64 size);
633  };
634 }
635 
636 namespace OrthancClient
637 {
644  class Patient
645  {
646  friend class ::OrthancClient::OrthancConnection;
647  friend class ::OrthancClient::Series;
648  friend class ::OrthancClient::Study;
649  friend class ::OrthancClient::Instance;
650  private:
651  bool isReference_;
652  Patient& operator= (const Patient&); // Assignment is forbidden
653  void* pimpl_;
654  Patient(void* pimpl) : isReference_(true), pimpl_(pimpl) {}
655  public:
663  Patient(const Patient& other) : isReference_(true), pimpl_(other.pimpl_) { }
664  inline Patient(::OrthancClient::OrthancConnection& connection, const ::std::string& id);
665  inline ~Patient();
666  inline void Reload();
667  inline LAAW_UINT32 GetStudyCount();
668  inline ::OrthancClient::Study GetStudy(LAAW_UINT32 index);
669  inline ::std::string GetId() const;
670  inline ::std::string GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const;
671  };
672 }
673 
674 namespace OrthancClient
675 {
682  class Series
683  {
684  friend class ::OrthancClient::OrthancConnection;
685  friend class ::OrthancClient::Patient;
686  friend class ::OrthancClient::Study;
687  friend class ::OrthancClient::Instance;
688  private:
689  bool isReference_;
690  Series& operator= (const Series&); // Assignment is forbidden
691  void* pimpl_;
692  Series(void* pimpl) : isReference_(true), pimpl_(pimpl) {}
693  public:
701  Series(const Series& other) : isReference_(true), pimpl_(other.pimpl_) { }
702  inline Series(::OrthancClient::OrthancConnection& connection, const ::std::string& id);
703  inline ~Series();
704  inline void Reload();
705  inline LAAW_UINT32 GetInstanceCount();
706  inline ::OrthancClient::Instance GetInstance(LAAW_UINT32 index);
707  inline ::std::string GetId() const;
708  inline ::std::string GetUrl() const;
709  inline ::std::string GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const;
710  inline bool Is3DImage();
711  inline LAAW_UINT32 GetWidth();
712  inline LAAW_UINT32 GetHeight();
713  inline float GetVoxelSizeX();
714  inline float GetVoxelSizeY();
715  inline float GetVoxelSizeZ();
716  inline float GetSliceThickness();
717  inline void Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride);
718  inline void Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride, float progress[]);
719  };
720 }
721 
722 namespace OrthancClient
723 {
730  class Study
731  {
732  friend class ::OrthancClient::OrthancConnection;
733  friend class ::OrthancClient::Patient;
734  friend class ::OrthancClient::Series;
735  friend class ::OrthancClient::Instance;
736  private:
737  bool isReference_;
738  Study& operator= (const Study&); // Assignment is forbidden
739  void* pimpl_;
740  Study(void* pimpl) : isReference_(true), pimpl_(pimpl) {}
741  public:
749  Study(const Study& other) : isReference_(true), pimpl_(other.pimpl_) { }
750  inline Study(::OrthancClient::OrthancConnection& connection, const ::std::string& id);
751  inline ~Study();
752  inline void Reload();
753  inline LAAW_UINT32 GetSeriesCount();
754  inline ::OrthancClient::Series GetSeries(LAAW_UINT32 index);
755  inline ::std::string GetId() const;
756  inline ::std::string GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const;
757  };
758 }
759 
760 namespace OrthancClient
761 {
768  class Instance
769  {
770  friend class ::OrthancClient::OrthancConnection;
771  friend class ::OrthancClient::Patient;
772  friend class ::OrthancClient::Series;
773  friend class ::OrthancClient::Study;
774  private:
775  bool isReference_;
776  Instance& operator= (const Instance&); // Assignment is forbidden
777  void* pimpl_;
778  Instance(void* pimpl) : isReference_(true), pimpl_(pimpl) {}
779  public:
787  Instance(const Instance& other) : isReference_(true), pimpl_(other.pimpl_) { }
788  inline Instance(::OrthancClient::OrthancConnection& connection, const ::std::string& id);
789  inline ~Instance();
790  inline ::std::string GetId() const;
793  inline ::std::string GetTagAsString(const ::std::string& tag) const;
794  inline float GetTagAsFloat(const ::std::string& tag) const;
795  inline LAAW_INT32 GetTagAsInt(const ::std::string& tag) const;
796  inline LAAW_UINT32 GetWidth();
797  inline LAAW_UINT32 GetHeight();
798  inline LAAW_UINT32 GetPitch();
800  inline const void* GetBuffer();
801  inline const void* GetBuffer(LAAW_UINT32 y);
802  inline LAAW_UINT64 GetDicomSize();
803  inline const void* GetDicom();
804  inline void DiscardImage();
805  inline void DiscardDicom();
806  inline void LoadTagContent(const ::std::string& path);
807  inline ::std::string GetLoadedTagContent() const;
808  };
809 }
810 
811 namespace OrthancClient
812 {
820  inline OrthancConnection::OrthancConnection(const ::std::string& orthancUrl)
821  {
822  isReference_ = false;
823  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, const char*);
824  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(0);
825  char* error = function(&pimpl_, orthancUrl.c_str());
826  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
827  }
837  inline OrthancConnection::OrthancConnection(const ::std::string& orthancUrl, const ::std::string& username, const ::std::string& password)
838  {
839  isReference_ = false;
840  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, const char*, const char*, const char*);
841  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(1);
842  char* error = function(&pimpl_, orthancUrl.c_str(), username.c_str(), password.c_str());
843  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
844  }
852  {
853  if (isReference_) return;
854  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*);
855  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(2);
856  char* error = function(pimpl_);
857  error = error; // Remove warning about unused variable
858  }
866  inline LAAW_UINT32 OrthancConnection::GetThreadCount() const
867  {
868  LAAW_UINT32 result_;
869  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, LAAW_UINT32*);
870  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(3);
871  char* error = function(pimpl_, &result_);
872  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
873  return result_;
874  }
882  inline void OrthancConnection::SetThreadCount(LAAW_UINT32 threadCount)
883  {
884  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32);
885  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(4);
886  char* error = function(pimpl_, threadCount);
887  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
888  }
896  {
897  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*);
898  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(5);
899  char* error = function(pimpl_);
900  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
901  }
909  inline ::std::string OrthancConnection::GetOrthancUrl() const
910  {
911  const char* result_;
912  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**);
913  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(6);
914  char* error = function(pimpl_, &result_);
915  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
916  return std::string(result_);
917  }
926  {
927  LAAW_UINT32 result_;
928  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*);
929  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(7);
930  char* error = function(pimpl_, &result_);
931  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
932  return result_;
933  }
942  inline ::OrthancClient::Patient OrthancConnection::GetPatient(LAAW_UINT32 index)
943  {
944  void* result_;
945  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32);
946  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(8);
947  char* error = function(pimpl_, &result_, index);
948  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
949  return ::OrthancClient::Patient(result_);
950  }
959  inline void OrthancConnection::DeletePatient(LAAW_UINT32 index)
960  {
961  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32);
962  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(9);
963  char* error = function(pimpl_, index);
964  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
965  }
973  inline void OrthancConnection::StoreFile(const ::std::string& filename)
974  {
975  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const char*);
976  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(10);
977  char* error = function(pimpl_, filename.c_str());
978  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
979  }
988  inline void OrthancConnection::Store(const void* dicom, LAAW_UINT64 size)
989  {
990  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void*, LAAW_UINT64);
991  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(11);
992  char* error = function(pimpl_, dicom, size);
993  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
994  }
995 }
996 
997 namespace OrthancClient
998 {
1007  inline Patient::Patient(::OrthancClient::OrthancConnection& connection, const ::std::string& id)
1008  {
1009  isReference_ = false;
1010  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*);
1011  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(12);
1012  char* error = function(&pimpl_, connection.pimpl_, id.c_str());
1013  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1014  }
1022  {
1023  if (isReference_) return;
1024  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*);
1025  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(13);
1026  char* error = function(pimpl_);
1027  error = error; // Remove warning about unused variable
1028  }
1035  inline void Patient::Reload()
1036  {
1037  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*);
1038  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(14);
1039  char* error = function(pimpl_);
1040  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1041  }
1049  inline LAAW_UINT32 Patient::GetStudyCount()
1050  {
1051  LAAW_UINT32 result_;
1052  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*);
1053  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(15);
1054  char* error = function(pimpl_, &result_);
1055  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1056  return result_;
1057  }
1066  inline ::OrthancClient::Study Patient::GetStudy(LAAW_UINT32 index)
1067  {
1068  void* result_;
1069  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32);
1070  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(16);
1071  char* error = function(pimpl_, &result_, index);
1072  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1073  return ::OrthancClient::Study(result_);
1074  }
1082  inline ::std::string Patient::GetId() const
1083  {
1084  const char* result_;
1085  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**);
1086  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(17);
1087  char* error = function(pimpl_, &result_);
1088  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1089  return std::string(result_);
1090  }
1100  inline ::std::string Patient::GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const
1101  {
1102  const char* result_;
1103  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*, const char*);
1104  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(18);
1105  char* error = function(pimpl_, &result_, tag.c_str(), defaultValue.c_str());
1106  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1107  return std::string(result_);
1108  }
1109 }
1110 
1111 namespace OrthancClient
1112 {
1121  inline Series::Series(::OrthancClient::OrthancConnection& connection, const ::std::string& id)
1122  {
1123  isReference_ = false;
1124  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*);
1125  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(19);
1126  char* error = function(&pimpl_, connection.pimpl_, id.c_str());
1127  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1128  }
1136  {
1137  if (isReference_) return;
1138  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*);
1139  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(20);
1140  char* error = function(pimpl_);
1141  error = error; // Remove warning about unused variable
1142  }
1149  inline void Series::Reload()
1150  {
1151  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*);
1152  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(21);
1153  char* error = function(pimpl_);
1154  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1155  }
1163  inline LAAW_UINT32 Series::GetInstanceCount()
1164  {
1165  LAAW_UINT32 result_;
1166  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*);
1167  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(22);
1168  char* error = function(pimpl_, &result_);
1169  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1170  return result_;
1171  }
1180  inline ::OrthancClient::Instance Series::GetInstance(LAAW_UINT32 index)
1181  {
1182  void* result_;
1183  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32);
1184  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(23);
1185  char* error = function(pimpl_, &result_, index);
1186  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1187  return ::OrthancClient::Instance(result_);
1188  }
1196  inline ::std::string Series::GetId() const
1197  {
1198  const char* result_;
1199  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**);
1200  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(24);
1201  char* error = function(pimpl_, &result_);
1202  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1203  return std::string(result_);
1204  }
1212  inline ::std::string Series::GetUrl() const
1213  {
1214  const char* result_;
1215  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**);
1216  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(25);
1217  char* error = function(pimpl_, &result_);
1218  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1219  return std::string(result_);
1220  }
1230  inline ::std::string Series::GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const
1231  {
1232  const char* result_;
1233  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*, const char*);
1234  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(26);
1235  char* error = function(pimpl_, &result_, tag.c_str(), defaultValue.c_str());
1236  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1237  return std::string(result_);
1238  }
1246  inline bool Series::Is3DImage()
1247  {
1248  LAAW_INT32 result_;
1249  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_INT32*);
1250  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(27);
1251  char* error = function(pimpl_, &result_);
1252  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1253  return result_ != 0;
1254  }
1262  inline LAAW_UINT32 Series::GetWidth()
1263  {
1264  LAAW_UINT32 result_;
1265  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*);
1266  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(28);
1267  char* error = function(pimpl_, &result_);
1268  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1269  return result_;
1270  }
1278  inline LAAW_UINT32 Series::GetHeight()
1279  {
1280  LAAW_UINT32 result_;
1281  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*);
1282  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(29);
1283  char* error = function(pimpl_, &result_);
1284  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1285  return result_;
1286  }
1294  inline float Series::GetVoxelSizeX()
1295  {
1296  float result_;
1297  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*);
1298  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(30);
1299  char* error = function(pimpl_, &result_);
1300  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1301  return result_;
1302  }
1310  inline float Series::GetVoxelSizeY()
1311  {
1312  float result_;
1313  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*);
1314  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(31);
1315  char* error = function(pimpl_, &result_);
1316  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1317  return result_;
1318  }
1326  inline float Series::GetVoxelSizeZ()
1327  {
1328  float result_;
1329  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*);
1330  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(32);
1331  char* error = function(pimpl_, &result_);
1332  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1333  return result_;
1334  }
1343  {
1344  float result_;
1345  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, float*);
1346  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(33);
1347  char* error = function(pimpl_, &result_);
1348  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1349  return result_;
1350  }
1361  inline void Series::Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride)
1362  {
1363  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void*, LAAW_INT32, LAAW_INT64, LAAW_INT64);
1364  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(34);
1365  char* error = function(pimpl_, target, format, lineStride, stackStride);
1366  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1367  }
1379  inline void Series::Load3DImage(void* target, ::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride, float progress[])
1380  {
1381  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void*, LAAW_INT32, LAAW_INT64, LAAW_INT64, float*);
1382  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(35);
1383  char* error = function(pimpl_, target, format, lineStride, stackStride, progress);
1384  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1385  }
1386 }
1387 
1388 namespace OrthancClient
1389 {
1398  inline Study::Study(::OrthancClient::OrthancConnection& connection, const ::std::string& id)
1399  {
1400  isReference_ = false;
1401  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*);
1402  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(36);
1403  char* error = function(&pimpl_, connection.pimpl_, id.c_str());
1404  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1405  }
1412  inline Study::~Study()
1413  {
1414  if (isReference_) return;
1415  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*);
1416  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(37);
1417  char* error = function(pimpl_);
1418  error = error; // Remove warning about unused variable
1419  }
1426  inline void Study::Reload()
1427  {
1428  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*);
1429  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(38);
1430  char* error = function(pimpl_);
1431  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1432  }
1440  inline LAAW_UINT32 Study::GetSeriesCount()
1441  {
1442  LAAW_UINT32 result_;
1443  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*);
1444  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(39);
1445  char* error = function(pimpl_, &result_);
1446  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1447  return result_;
1448  }
1457  inline ::OrthancClient::Series Study::GetSeries(LAAW_UINT32 index)
1458  {
1459  void* result_;
1460  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, void**, LAAW_UINT32);
1461  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(40);
1462  char* error = function(pimpl_, &result_, index);
1463  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1464  return ::OrthancClient::Series(result_);
1465  }
1473  inline ::std::string Study::GetId() const
1474  {
1475  const char* result_;
1476  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**);
1477  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(41);
1478  char* error = function(pimpl_, &result_);
1479  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1480  return std::string(result_);
1481  }
1491  inline ::std::string Study::GetMainDicomTag(const ::std::string& tag, const ::std::string& defaultValue) const
1492  {
1493  const char* result_;
1494  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*, const char*);
1495  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(42);
1496  char* error = function(pimpl_, &result_, tag.c_str(), defaultValue.c_str());
1497  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1498  return std::string(result_);
1499  }
1500 }
1501 
1502 namespace OrthancClient
1503 {
1512  inline Instance::Instance(::OrthancClient::OrthancConnection& connection, const ::std::string& id)
1513  {
1514  isReference_ = false;
1515  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void**, void*, const char*);
1516  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(43);
1517  char* error = function(&pimpl_, connection.pimpl_, id.c_str());
1518  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1519  }
1527  {
1528  if (isReference_) return;
1529  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*);
1530  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(44);
1531  char* error = function(pimpl_);
1532  error = error; // Remove warning about unused variable
1533  }
1541  inline ::std::string Instance::GetId() const
1542  {
1543  const char* result_;
1544  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**);
1545  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(45);
1546  char* error = function(pimpl_, &result_);
1547  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1548  return std::string(result_);
1549  }
1558  {
1559  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_INT32);
1560  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(46);
1561  char* error = function(pimpl_, mode);
1562  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1563  }
1572  {
1573  LAAW_INT32 result_;
1574  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, LAAW_INT32*);
1575  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(47);
1576  char* error = function(pimpl_, &result_);
1577  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1578  return static_cast< ::Orthanc::ImageExtractionMode >(result_);
1579  }
1588  inline ::std::string Instance::GetTagAsString(const ::std::string& tag) const
1589  {
1590  const char* result_;
1591  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**, const char*);
1592  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(48);
1593  char* error = function(pimpl_, &result_, tag.c_str());
1594  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1595  return std::string(result_);
1596  }
1605  inline float Instance::GetTagAsFloat(const ::std::string& tag) const
1606  {
1607  float result_;
1608  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, float*, const char*);
1609  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(49);
1610  char* error = function(pimpl_, &result_, tag.c_str());
1611  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1612  return result_;
1613  }
1622  inline LAAW_INT32 Instance::GetTagAsInt(const ::std::string& tag) const
1623  {
1624  LAAW_INT32 result_;
1625  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, LAAW_INT32*, const char*);
1626  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(50);
1627  char* error = function(pimpl_, &result_, tag.c_str());
1628  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1629  return result_;
1630  }
1638  inline LAAW_UINT32 Instance::GetWidth()
1639  {
1640  LAAW_UINT32 result_;
1641  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*);
1642  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(51);
1643  char* error = function(pimpl_, &result_);
1644  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1645  return result_;
1646  }
1654  inline LAAW_UINT32 Instance::GetHeight()
1655  {
1656  LAAW_UINT32 result_;
1657  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*);
1658  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(52);
1659  char* error = function(pimpl_, &result_);
1660  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1661  return result_;
1662  }
1670  inline LAAW_UINT32 Instance::GetPitch()
1671  {
1672  LAAW_UINT32 result_;
1673  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT32*);
1674  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(53);
1675  char* error = function(pimpl_, &result_);
1676  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1677  return result_;
1678  }
1687  {
1688  LAAW_INT32 result_;
1689  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_INT32*);
1690  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(54);
1691  char* error = function(pimpl_, &result_);
1692  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1693  return static_cast< ::Orthanc::PixelFormat >(result_);
1694  }
1702  inline const void* Instance::GetBuffer()
1703  {
1704  const void* result_;
1705  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void**);
1706  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(55);
1707  char* error = function(pimpl_, &result_);
1708  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1709  return reinterpret_cast< const void* >(result_);
1710  }
1719  inline const void* Instance::GetBuffer(LAAW_UINT32 y)
1720  {
1721  const void* result_;
1722  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void**, LAAW_UINT32);
1723  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(56);
1724  char* error = function(pimpl_, &result_, y);
1725  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1726  return reinterpret_cast< const void* >(result_);
1727  }
1735  inline LAAW_UINT64 Instance::GetDicomSize()
1736  {
1737  LAAW_UINT64 result_;
1738  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, LAAW_UINT64*);
1739  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(57);
1740  char* error = function(pimpl_, &result_);
1741  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1742  return result_;
1743  }
1751  inline const void* Instance::GetDicom()
1752  {
1753  const void* result_;
1754  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const void**);
1755  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(58);
1756  char* error = function(pimpl_, &result_);
1757  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1758  return reinterpret_cast< const void* >(result_);
1759  }
1767  {
1768  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*);
1769  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(59);
1770  char* error = function(pimpl_);
1771  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1772  }
1780  {
1781  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*);
1782  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(60);
1783  char* error = function(pimpl_);
1784  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1785  }
1793  inline void Instance::LoadTagContent(const ::std::string& path)
1794  {
1795  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (void*, const char*);
1796  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(61);
1797  char* error = function(pimpl_, path.c_str());
1798  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1799  }
1807  inline ::std::string Instance::GetLoadedTagContent() const
1808  {
1809  const char* result_;
1810  typedef char* (LAAW_ORTHANC_CLIENT_CALL_CONV* Function) (const void*, const char**);
1811  Function function = (Function) ::OrthancClient::Internals::Library::GetInstance().GetFunction(62);
1812  char* error = function(pimpl_, &result_);
1813  ::OrthancClient::Internals::Library::GetInstance().ThrowExceptionIfNeeded(error);
1814  return std::string(result_);
1815  }
1816 }
1817 
float GetVoxelSizeX()
Get the physical size of a voxel along the X-axis.
Definition: OrthancCppClient.h:1294
float GetVoxelSizeZ()
Get the physical size of a voxel along the Z-axis.
Definition: OrthancCppClient.h:1326
float GetSliceThickness()
Get the slice thickness.
Definition: OrthancCppClient.h:1342
Connection to a study stored in Orthanc.
Definition: OrthancCppClient.h:730
LAAW_UINT32 GetHeight()
Get the height of the 3D image.
Definition: OrthancCppClient.h:1278
LAAW_UINT32 GetPatientCount()
Returns the number of patients.
Definition: OrthancCppClient.h:925
~Series()
Destructs the object.
Definition: OrthancCppClient.h:1135
LAAW_UINT32 GetInstanceCount()
Return the number of instances for this series.
Definition: OrthancCppClient.h:1163
void Store(const void *dicom, LAAW_UINT64 size)
Send a DICOM file that is contained inside a memory buffer.
Definition: OrthancCppClient.h:988
Graylevel, signed 16bpp image.
Definition: OrthancCppClient.h:519
Graylevel, unsigned 16bpp image.
Definition: OrthancCppClient.h:547
bool Is3DImage()
Test whether this series encodes a 3D image that can be downloaded from Orthanc.
Definition: OrthancCppClient.h:1246
const void * GetBuffer()
Access the memory buffer in which the raw pixels of the 2D image are stored.
Definition: OrthancCppClient.h:1702
PixelFormat
The memory layout of the pixels (resp. voxels) of a 2D (resp. 3D) image.
Definition: OrthancCppClient.h:511
Instance(const Instance &other)
Construct a new reference to this object.
Definition: OrthancCppClient.h:787
inline::std::string GetMainDicomTag(const ::std::string &tag, const ::std::string &defaultValue) const
Get the value of one of the main DICOM tags for this series.
Definition: OrthancCppClient.h:1230
Connection to an instance stored in Orthanc.
Definition: OrthancCppClient.h:768
inline::std::string GetId() const
Get the Orthanc identifier of this study.
Definition: OrthancCppClient.h:1473
Patient(const Patient &other)
Construct a new reference to this object.
Definition: OrthancCppClient.h:663
void SetImageExtractionMode(::Orthanc::ImageExtractionMode mode)
Set the extraction mode for the 2D image corresponding to this instance.
Definition: OrthancCppClient.h:1557
Truncation to the [0, 65535] range.
Definition: OrthancCppClient.h:589
inline::std::string GetUrl() const
Returns the URL to this series.
Definition: OrthancCppClient.h:1212
Truncation to the [-32768, 32767] range.
Definition: OrthancCppClient.h:568
inline::std::string GetLoadedTagContent() const
Return the value of the raw tag that was loaded by LoadContent.
Definition: OrthancCppClient.h:1807
inline::std::string GetId() const
Get the Orthanc identifier of this patient.
Definition: OrthancCppClient.h:1082
void Load3DImage(void *target,::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride)
Load the 3D image into a memory buffer.
Definition: OrthancCppClient.h:1361
LAAW_UINT64 GetDicomSize()
Get the size of the DICOM file corresponding to this instance.
Definition: OrthancCppClient.h:1735
LAAW_UINT32 GetWidth()
Get the width of the 2D image.
Definition: OrthancCppClient.h:1638
const std::string & What() const
Get the error message associated with this exception.
Definition: OrthancCppClient.h:188
Connection to a patient stored in Orthanc.
Definition: OrthancCppClient.h:644
inline::OrthancClient::Instance GetInstance(LAAW_UINT32 index)
Get some instance of this series.
Definition: OrthancCppClient.h:1180
inline::std::string GetId() const
Get the Orthanc identifier of this series.
Definition: OrthancCppClient.h:1196
void Reload()
Reload the instances of this series.
Definition: OrthancCppClient.h:1149
LAAW_UINT32 GetThreadCount() const
Returns the number of threads for this connection.
Definition: OrthancCppClient.h:866
inline::OrthancClient::Patient GetPatient(LAAW_UINT32 index)
Get some patient.
Definition: OrthancCppClient.h:942
void LoadTagContent(const ::std::string &path)
Load a raw tag from the DICOM file.
Definition: OrthancCppClient.h:1793
inline::std::string GetMainDicomTag(const ::std::string &tag, const ::std::string &defaultValue) const
Get the value of one of the main DICOM tags for this study.
Definition: OrthancCppClient.h:1491
~Instance()
Destructs the object.
Definition: OrthancCppClient.h:1526
void DiscardImage()
Discard the downloaded 2D image, so as to make room in memory.
Definition: OrthancCppClient.h:1766
void DeletePatient(LAAW_UINT32 index)
Delete some patient.
Definition: OrthancCppClient.h:959
void DiscardDicom()
Discard the downloaded DICOM file, so as to make room in memory.
Definition: OrthancCppClient.h:1779
LAAW_UINT32 GetStudyCount()
Return the number of studies for this patient.
Definition: OrthancCppClient.h:1049
Exception class that is thrown by the functions of this shared library.
Definition: OrthancCppClient.h:166
LAAW_UINT32 GetSeriesCount()
Return the number of series for this study.
Definition: OrthancCppClient.h:1440
inline::Orthanc::ImageExtractionMode GetImageExtractionMode() const
Get the extraction mode for the 2D image corresponding to this instance.
Definition: OrthancCppClient.h:1571
void Finalize()
Manually finalize the shared library.
Definition: OrthancCppClient.h:371
inline::OrthancClient::Series GetSeries(LAAW_UINT32 index)
Get some series of this study.
Definition: OrthancCppClient.h:1457
Color image in RGB24 format.
Definition: OrthancCppClient.h:526
Color image in RGBA32 format.
Definition: OrthancCppClient.h:533
Truncation to the [0, 255] range.
Definition: OrthancCppClient.h:582
float GetTagAsFloat(const ::std::string &tag) const
Get the floating point value that is stored in some DICOM tag of this instance.
Definition: OrthancCppClient.h:1605
Graylevel 8bpp image.
Definition: OrthancCppClient.h:540
inline::Orthanc::PixelFormat GetPixelFormat()
Get the format of the pixels of the 2D image.
Definition: OrthancCppClient.h:1686
inline::std::string GetTagAsString(const ::std::string &tag) const
Get the string value of some DICOM tag of this instance.
Definition: OrthancCppClient.h:1588
Definition: OrthancCppClient.h:502
Series(const Series &other)
Construct a new reference to this object.
Definition: OrthancCppClient.h:701
LAAW_UINT32 GetPitch()
Get the number of bytes between two lines of the image (pitch).
Definition: OrthancCppClient.h:1670
OrthancConnection(const OrthancConnection &other)
Construct a new reference to this object.
Definition: OrthancCppClient.h:620
ImageExtractionMode
The extraction mode specifies the way the values of the pixels are scaled when downloading a 2D image...
Definition: OrthancCppClient.h:560
~OrthancConnection()
Destructs the object.
Definition: OrthancCppClient.h:851
Definition: OrthancCppClient.h:162
LAAW_UINT32 GetHeight()
Get the height of the 2D image.
Definition: OrthancCppClient.h:1654
OrthancClientException(std::string message)
Constructs an exception.
Definition: OrthancCppClient.h:176
void Initialize(const std::string &sharedLibraryPath)
Manually initialize the shared library.
Definition: OrthancCppClient.h:358
~Patient()
Destructs the object.
Definition: OrthancCppClient.h:1021
void SetThreadCount(LAAW_UINT32 threadCount)
Sets the number of threads for this connection.
Definition: OrthancCppClient.h:882
~Study()
Destructs the object.
Definition: OrthancCppClient.h:1412
Connection to a series stored in Orthanc.
Definition: OrthancCppClient.h:682
void StoreFile(const ::std::string &filename)
Send a DICOM file.
Definition: OrthancCppClient.h:973
inline::std::string GetId() const
Get the Orthanc identifier of this identifier.
Definition: OrthancCppClient.h:1541
LAAW_INT32 GetTagAsInt(const ::std::string &tag) const
Get the integer value that is stored in some DICOM tag of this instance.
Definition: OrthancCppClient.h:1622
void Reload()
Reload the list of the patients.
Definition: OrthancCppClient.h:895
LAAW_UINT32 GetWidth()
Get the width of the 3D image.
Definition: OrthancCppClient.h:1262
Rescaled to 8bpp.
Definition: OrthancCppClient.h:575
inline::std::string GetOrthancUrl() const
Returns the URL of this instance of Orthanc.
Definition: OrthancCppClient.h:909
float GetVoxelSizeY()
Get the physical size of a voxel along the Y-axis.
Definition: OrthancCppClient.h:1310
inline::OrthancClient::Study GetStudy(LAAW_UINT32 index)
Get some study of this patient.
Definition: OrthancCppClient.h:1066
inline::std::string GetMainDicomTag(const ::std::string &tag, const ::std::string &defaultValue) const
Get the value of one of the main DICOM tags for this patient.
Definition: OrthancCppClient.h:1100
Connection to an instance of Orthanc.
Definition: OrthancCppClient.h:601
const void * GetDicom()
Get a pointer to the content of the DICOM file corresponding to this instance.
Definition: OrthancCppClient.h:1751
Study(const Study &other)
Construct a new reference to this object.
Definition: OrthancCppClient.h:749
void Reload()
Reload the studies of this patient.
Definition: OrthancCppClient.h:1035
void Reload()
Reload the series of this study.
Definition: OrthancCppClient.h:1426