Mercurial > hg > orthanc
comparison OrthancCppClient/Study.h @ 593:9d2592c08919
documentation completed
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 04 Oct 2013 15:04:37 +0200 |
parents | ec19da4a1fe7 |
children | 2d0a347e8cfc |
comparison
equal
deleted
inserted
replaced
592:c5ee586a0a08 | 593:9d2592c08919 |
---|---|
34 | 34 |
35 #include "Series.h" | 35 #include "Series.h" |
36 | 36 |
37 namespace OrthancClient | 37 namespace OrthancClient |
38 { | 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 **/ | |
39 class LAAW_API Study : | 44 class LAAW_API Study : |
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 study.} | |
66 * {param}{connection The remote instance of %Orthanc.} | |
67 * {param}{id The %Orthanc identifier of the study.} | |
68 **/ | |
59 Study(const OrthancConnection& connection, | 69 Study(const OrthancConnection& connection, |
60 const char* id); | 70 const char* id); |
61 | 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 **/ | |
62 void Reload() | 76 void Reload() |
63 { | 77 { |
64 series_.Reload(); | 78 series_.Reload(); |
65 } | 79 } |
66 | 80 |
81 /** | |
82 * {summary}{Return the number of series for this study.} | |
83 * {returns}{The number of series.} | |
84 **/ | |
67 uint32_t GetSeriesCount() | 85 uint32_t GetSeriesCount() |
68 { | 86 { |
69 return series_.GetSize(); | 87 return series_.GetSize(); |
70 } | 88 } |
71 | 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 **/ | |
72 Series& GetSeries(uint32_t index) | 96 Series& GetSeries(uint32_t index) |
73 { | 97 { |
74 return dynamic_cast<Series&>(series_.GetItem(index)); | 98 return dynamic_cast<Series&>(series_.GetItem(index)); |
75 } | 99 } |
76 | 100 |
101 /** | |
102 * {summary}{Get the %Orthanc identifier of this study.} | |
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 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 **/ | |
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 } | 119 } |