Mercurial > hg > orthanc-client
comparison OrthancCppClient/Study.h @ 0:ebc1e38ef615
initial commit
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Mon, 01 Jun 2015 09:47:32 +0200 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:ebc1e38ef615 |
---|---|
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 | |
35 #include "Series.h" | |
36 | |
37 namespace OrthancClient | |
38 { | |
39 /** | |
40 * {summary}{Connection to a study stored in %Orthanc.} | |
41 * {description}{This class encapsulates a connection to a study | |
42 * from a remote instance of %Orthanc.} | |
43 **/ | |
44 class LAAW_API Study : | |
45 public Orthanc::IDynamicObject, | |
46 private Orthanc::ArrayFilledByThreads::IFiller | |
47 { | |
48 private: | |
49 const OrthancConnection& connection_; | |
50 std::string id_; | |
51 Json::Value study_; | |
52 Orthanc::ArrayFilledByThreads series_; | |
53 | |
54 void ReadStudy(); | |
55 | |
56 virtual size_t GetFillerSize() | |
57 { | |
58 return study_["Series"].size(); | |
59 } | |
60 | |
61 virtual Orthanc::IDynamicObject* GetFillerItem(size_t index); | |
62 | |
63 public: | |
64 /** | |
65 * {summary}{Create a connection to some study.} | |
66 * {param}{connection The remote instance of %Orthanc.} | |
67 * {param}{id The %Orthanc identifier of the study.} | |
68 **/ | |
69 Study(const OrthancConnection& connection, | |
70 const char* id); | |
71 | |
72 /** | |
73 * {summary}{Reload the series of this study.} | |
74 * {description}{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.} | |
75 **/ | |
76 void Reload() | |
77 { | |
78 series_.Reload(); | |
79 } | |
80 | |
81 /** | |
82 * {summary}{Return the number of series for this study.} | |
83 * {returns}{The number of series.} | |
84 **/ | |
85 uint32_t GetSeriesCount() | |
86 { | |
87 return series_.GetSize(); | |
88 } | |
89 | |
90 /** | |
91 * {summary}{Get some series of this study.} | |
92 * {description}{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).} | |
93 * {param}{index The index of the series of interest.} | |
94 * {returns}{The series.} | |
95 **/ | |
96 Series& GetSeries(uint32_t index) | |
97 { | |
98 return dynamic_cast<Series&>(series_.GetItem(index)); | |
99 } | |
100 | |
101 /** | |
102 * {summary}{Get the %Orthanc identifier of this study.} | |
103 * {returns}{The identifier.} | |
104 **/ | |
105 const char* GetId() const | |
106 { | |
107 return id_.c_str(); | |
108 } | |
109 | |
110 /** | |
111 * {summary}{Get the value of one of the main DICOM tags for this study.} | |
112 * {param}{tag The name of the tag of interest ("StudyDate", "StudyDescription", "StudyInstanceUID" or "StudyTime").} | |
113 * {param}{defaultValue The default value to be returned if this tag does not exist.} | |
114 * {returns}{The value of the tag.} | |
115 **/ | |
116 const char* GetMainDicomTag(const char* tag, | |
117 const char* defaultValue) const; | |
118 }; | |
119 } |