Mercurial > hg > orthanc

comparison OrthancCppClient/Patient.h @ 593:9d2592c08919

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documentation completed
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 04 Oct 2013 15:04:37 +0200
parents eaca3d38b2aa
children 2d0a347e8cfc
comparison
equal deleted inserted replaced
592:c5ee586a0a08 593:9d2592c08919
34 34
35 #include "Study.h" 35 #include "Study.h"
36 36
37 namespace OrthancClient 37 namespace OrthancClient
38 { 38 {
39 /**
40 * {summary}{Connection to a patient stored in %Orthanc.}
41 * {description}{This class encapsulates a connection to a patient
42 * from a remote instance of %Orthanc.}
43 **/
39 class LAAW_API Patient : 44 class LAAW_API Patient :
40 public Orthanc::IDynamicObject, 45 public Orthanc::IDynamicObject,
41 private Orthanc::ArrayFilledByThreads::IFiller 46 private Orthanc::ArrayFilledByThreads::IFiller
42 { 47 {
43 private: 48 private:
54 } 59 }
55 60
56 virtual Orthanc::IDynamicObject* GetFillerItem(size_t index); 61 virtual Orthanc::IDynamicObject* GetFillerItem(size_t index);
57 62
58 public: 63 public:
64 /**
65 * {summary}{Create a connection to some patient.}
66 * {param}{connection The remote instance of %Orthanc.}
67 * {param}{id The %Orthanc identifier of the patient.}
68 **/
59 Patient(const OrthancConnection& connection, 69 Patient(const OrthancConnection& connection,
60 const char* id); 70 const char* id);
61 71
72 /**
73 * {summary}{Reload the studies of this patient.}
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.}
75 **/
62 void Reload() 76 void Reload()
63 { 77 {
64 studies_.Reload(); 78 studies_.Reload();
65 } 79 }
66 80
81 /**
82 * {summary}{Return the number of studies for this patient.}
83 * {returns}{The number of studies.}
84 **/
67 uint32_t GetStudyCount() 85 uint32_t GetStudyCount()
68 { 86 {
69 return studies_.GetSize(); 87 return studies_.GetSize();
70 } 88 }
71 89
90 /**
91 * {summary}{Get some study of this patient.}
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).}
93 * {param}{index The index of the study of interest.}
94 * {returns}{The study.}
95 **/
72 Study& GetStudy(uint32_t index) 96 Study& GetStudy(uint32_t index)
73 { 97 {
74 return dynamic_cast<Study&>(studies_.GetItem(index)); 98 return dynamic_cast<Study&>(studies_.GetItem(index));
75 } 99 }
76 100
101 /**
102 * {summary}{Get the %Orthanc identifier of this patient.}
103 * {returns}{The identifier.}
104 **/
77 const char* GetId() const 105 const char* GetId() const
78 { 106 {
79 return id_.c_str(); 107 return id_.c_str();
80 } 108 }
81 109
110 /**
111 * {summary}{Get the value of one of the main DICOM tags for this patient.}
112 * {param}{tag The name of the tag of interest ("PatientName", "PatientID", "PatientSex" or "PatientBirthDate").}
113 * {param}{defaultValue The default value to be returned if this tag does not exist.}
114 * {returns}{The value of the tag.}
115 **/
82 const char* GetMainDicomTag(const char* tag, 116 const char* GetMainDicomTag(const char* tag,
83 const char* defaultValue) const; 117 const char* defaultValue) const;
84 118
85 LAAW_API_INTERNAL void Delete(); 119 LAAW_API_INTERNAL void Delete();
86 }; 120 };