annotate CppClient/Patient.h @ 7:39730d6727f3

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