Mercurial > hg > orthanc

annotate OrthancCppClient/Study.h @ 696:4c1860179cc5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
dictionary of user-defined content types
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 05 Feb 2014 15:00:29 +0100
parents 2d0a347e8cfc
children 6e7e5ed91c2d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
479
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
689
2d0a347e8cfc switch to 2014
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 593
diff changeset
3 * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege,
479
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Belgium
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * modify it under the terms of the GNU General Public License as
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * published by the Free Software Foundation, either version 3 of the
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * License, or (at your option) any later version.
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 *
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * In addition, as a special exception, the copyright holders of this
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * program give permission to link the code of its release with the
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * that use the same license as the "OpenSSL" library), and distribute
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * the linked executables. You must obey the GNU General Public License
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * in all respects for all of the code used other than "OpenSSL". If you
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * modify file(s) with this exception, you may extend this exception to
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * your version of the file(s), but you are not obligated to do so. If
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * you do not wish to do so, delete this exception statement from your
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * version. If you delete this exception statement from all source files
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * in the program, then also delete it here.
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * This program is distributed in the hope that it will be useful, but
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * General Public License for more details.
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 *
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * You should have received a copy of the GNU General Public License
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 **/
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #pragma once
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #include "Series.h"
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 namespace OrthancClient
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 {
593
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
39 /**
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
40 * {summary}{Connection to a study stored in %Orthanc.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
41 * {description}{This class encapsulates a connection to a study
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
42 * from a remote instance of %Orthanc.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
43 **/
498
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 496
diff changeset
44 class LAAW_API Study :
480
482cde3f3c14 sample of c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 479
diff changeset
45 public Orthanc::IDynamicObject,
482cde3f3c14 sample of c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 479
diff changeset
46 private Orthanc::ArrayFilledByThreads::IFiller
479
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 {
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 private:
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 const OrthancConnection& connection_;
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 std::string id_;
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 Json::Value study_;
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 Orthanc::ArrayFilledByThreads series_;
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 void ReadStudy();
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 virtual size_t GetFillerSize()
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 {
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 return study_["Series"].size();
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 }
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 virtual Orthanc::IDynamicObject* GetFillerItem(size_t index);
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 public:
593
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
64 /**
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
65 * {summary}{Create a connection to some study.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
66 * {param}{connection The remote instance of %Orthanc.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
67 * {param}{id The %Orthanc identifier of the study.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
68 **/
479
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 Study(const OrthancConnection& connection,
500
ec19da4a1fe7 fix api
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 498
diff changeset
70 const char* id);
479
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
593
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
72 /**
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
73 * {summary}{Reload the series of this study.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
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.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
75 **/
479
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 void Reload()
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 {
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 series_.Reload();
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 }
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80
593
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
81 /**
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
82 * {summary}{Return the number of series for this study.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
83 * {returns}{The number of series.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
84 **/
496
7f7a2d174acb preparing Laaw packaging
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 480
diff changeset
85 uint32_t GetSeriesCount()
479
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 {
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 return series_.GetSize();
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 }
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
593
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
90 /**
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
91 * {summary}{Get some series of this study.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
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).}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
93 * {param}{index The index of the series of interest.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
94 * {returns}{The series.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
95 **/
496
7f7a2d174acb preparing Laaw packaging
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 480
diff changeset
96 Series& GetSeries(uint32_t index)
479
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 {
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 return dynamic_cast<Series&>(series_.GetItem(index));
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 }
593
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
100
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
101 /**
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
102 * {summary}{Get the %Orthanc identifier of this study.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
103 * {returns}{The identifier.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
104 **/
500
ec19da4a1fe7 fix api
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 498
diff changeset
105 const char* GetId() const
479
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 {
500
ec19da4a1fe7 fix api
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 498
diff changeset
107 return id_.c_str();
479
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 }
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109
593
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
110 /**
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
111 * {summary}{Get the value of one of the main DICOM tags for this study.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
112 * {param}{tag The name of the tag of interest ("StudyDate", "StudyDescription", "StudyInstanceUID" or "StudyTime").}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
113 * {param}{defaultValue The default value to be returned if this tag does not exist.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
114 * {returns}{The value of the tag.}
9d2592c08919 documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 500
diff changeset
115 **/
500
ec19da4a1fe7 fix api
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 498
diff changeset
116 const char* GetMainDicomTag(const char* tag,
479
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 const char* defaultValue) const;
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 };
0cd977e94479 initial commit of the c++ client
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 }