|
0
|
1 /**
|
|
|
2 * Orthanc - A Lightweight, RESTful DICOM Store
|
|
|
3 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics
|
|
|
4 * Department, University Hospital of Liege, Belgium
|
|
|
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 #pragma once
|
|
|
34
|
|
3
|
35 #include "../Orthanc/Core/HttpClient.h"
|
|
0
|
36
|
|
7
|
37 #include "PublicEnumerations.h"
|
|
0
|
38 #include "Patient.h"
|
|
|
39
|
|
|
40 namespace OrthancClient
|
|
|
41 {
|
|
|
42 /**
|
|
|
43 * {summary}{Connection to an instance of %Orthanc.}
|
|
|
44 * {description}{This class encapsulates a connection to a remote instance
|
|
|
45 * of %Orthanc through its REST API.}
|
|
|
46 **/
|
|
|
47 class LAAW_API OrthancConnection :
|
|
|
48 public boost::noncopyable,
|
|
6
|
49 private ArrayFilledByThreads::IFiller
|
|
0
|
50 {
|
|
|
51 private:
|
|
|
52 Orthanc::HttpClient client_;
|
|
|
53 std::string orthancUrl_;
|
|
6
|
54 ArrayFilledByThreads patients_;
|
|
0
|
55 Json::Value content_;
|
|
|
56
|
|
|
57 void ReadPatients();
|
|
|
58
|
|
|
59 virtual size_t GetFillerSize()
|
|
|
60 {
|
|
|
61 return content_.size();
|
|
|
62 }
|
|
|
63
|
|
|
64 virtual Orthanc::IDynamicObject* GetFillerItem(size_t index);
|
|
|
65
|
|
|
66 public:
|
|
|
67 /**
|
|
|
68 * {summary}{Create a connection to an instance of %Orthanc.}
|
|
|
69 * {param}{orthancUrl URL to which the REST API of %Orthanc is listening.}
|
|
|
70 **/
|
|
|
71 OrthancConnection(const char* orthancUrl);
|
|
|
72
|
|
|
73 /**
|
|
|
74 * {summary}{Create a connection to an instance of %Orthanc, with authentication.}
|
|
|
75 * {param}{orthancUrl URL to which the REST API of %Orthanc is listening.}
|
|
|
76 * {param}{username The username.}
|
|
|
77 * {param}{password The password.}
|
|
|
78 **/
|
|
|
79 OrthancConnection(const char* orthancUrl,
|
|
|
80 const char* username,
|
|
|
81 const char* password);
|
|
|
82
|
|
|
83 virtual ~OrthancConnection()
|
|
|
84 {
|
|
|
85 }
|
|
|
86
|
|
|
87 /**
|
|
|
88 * {summary}{Returns the number of threads for this connection.}
|
|
|
89 * {description}{Returns the number of simultaneous connections
|
|
|
90 * that are used when downloading information from this instance
|
|
|
91 * of %Orthanc.}
|
|
|
92 * {returns}{The number of threads.}
|
|
|
93 **/
|
|
|
94 uint32_t GetThreadCount() const
|
|
|
95 {
|
|
|
96 return patients_.GetThreadCount();
|
|
|
97 }
|
|
|
98
|
|
|
99 /**
|
|
|
100 * {summary}{Sets the number of threads for this connection.}
|
|
|
101 * {description}{Sets the number of simultaneous connections
|
|
|
102 * that are used when downloading information from this instance
|
|
|
103 * of %Orthanc.}
|
|
|
104 * {param}{threadCount The number of threads.}
|
|
|
105 **/
|
|
|
106 void SetThreadCount(uint32_t threadCount)
|
|
|
107 {
|
|
|
108 patients_.SetThreadCount(threadCount);
|
|
|
109 }
|
|
|
110
|
|
|
111 /**
|
|
|
112 * {summary}{Reload the list of the patients.}
|
|
|
113 * {description}{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.}
|
|
|
114 **/
|
|
|
115 void Reload()
|
|
|
116 {
|
|
|
117 ReadPatients();
|
|
|
118 patients_.Invalidate();
|
|
|
119 }
|
|
|
120
|
|
|
121 LAAW_API_INTERNAL const Orthanc::HttpClient& GetHttpClient() const
|
|
|
122 {
|
|
|
123 return client_;
|
|
|
124 }
|
|
|
125
|
|
|
126 /**
|
|
|
127 * {summary}{Returns the URL of this instance of %Orthanc.}
|
|
|
128 * {description}{Returns the URL of the remote %Orthanc instance to which this object is connected.}
|
|
|
129 * {returns}{The URL.}
|
|
|
130 **/
|
|
|
131 const char* GetOrthancUrl() const
|
|
|
132 {
|
|
|
133 return orthancUrl_.c_str();
|
|
|
134 }
|
|
|
135
|
|
|
136 /**
|
|
|
137 * {summary}{Returns the number of patients.}
|
|
|
138 * {description}{Returns the number of patients that are stored in the remote instance of %Orthanc.}
|
|
|
139 * {returns}{The number of patients.}
|
|
|
140 **/
|
|
|
141 uint32_t GetPatientCount()
|
|
|
142 {
|
|
|
143 return patients_.GetSize();
|
|
|
144 }
|
|
|
145
|
|
|
146 /**
|
|
|
147 * {summary}{Get some patient.}
|
|
|
148 * {description}{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).}
|
|
|
149 * {param}{index The index of the patient of interest.}
|
|
|
150 * {returns}{The patient.}
|
|
|
151 **/
|
|
|
152 Patient& GetPatient(uint32_t index);
|
|
|
153
|
|
|
154 /**
|
|
|
155 * {summary}{Delete some patient.}
|
|
|
156 * {description}{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.}
|
|
|
157 * {param}{index The index of the patient of interest.}
|
|
|
158 * {returns}{The patient.}
|
|
|
159 **/
|
|
|
160 void DeletePatient(uint32_t index)
|
|
|
161 {
|
|
|
162 GetPatient(index).Delete();
|
|
|
163 Reload();
|
|
|
164 }
|
|
|
165
|
|
|
166 /**
|
|
|
167 * {summary}{Send a DICOM file.}
|
|
|
168 * {description}{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.}
|
|
|
169 * {param}{filename Path to the DICOM file}
|
|
|
170 **/
|
|
|
171 void StoreFile(const char* filename);
|
|
|
172
|
|
|
173 /**
|
|
|
174 * {summary}{Send a DICOM file that is contained inside a memory buffer.}
|
|
|
175 * {description}{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.}
|
|
|
176 * {param}{dicom The memory buffer containing the DICOM file.}
|
|
|
177 * {param}{size The size of the DICOM file.}
|
|
|
178 **/
|
|
|
179 void Store(const void* dicom, uint64_t size);
|
|
|
180 };
|
|
|
181 }
|
