Connection to a study stored in Orthanc.
More...
#include <OrthancCppClient.h>
This class encapsulates a connection to a study from a remote instance of Orthanc.
OrthancClient::Study::Study |
( |
const Study & |
other | ) |
|
|
inline |
Construct a new reference to this object. Pay attention to the fact that when the referenced object is deleted, the content of this object will be invalid.
- Parameters
-
other | The original object. |
Create a connection to some study.
- Parameters
-
connection | The remote instance of Orthanc. |
id | The Orthanc identifier of the study. |
OrthancClient::Study::~Study |
( |
| ) |
|
|
inline |
std::string OrthancClient::Study::GetId |
( |
| ) |
const |
|
inline |
Get the Orthanc identifier of this study.
- Returns
- The identifier.
std::string OrthancClient::Study::GetMainDicomTag |
( |
const ::std::string & |
tag, |
|
|
const ::std::string & |
defaultValue |
|
) |
| const |
|
inline |
Get the value of one of the main DICOM tags for this study.
- Parameters
-
tag | The name of the tag of interest ("StudyDate", "StudyDescription", "StudyInstanceUID" or "StudyTime"). |
defaultValue | The default value to be returned if this tag does not exist. |
- Returns
- The value of the tag.
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).
- Parameters
-
index | The index of the series of interest. |
- Returns
- The series.
LAAW_UINT32 OrthancClient::Study::GetSeriesCount |
( |
| ) |
|
|
inline |
Return the number of series for this study.
- Returns
- The number of series.
void OrthancClient::Study::Reload |
( |
| ) |
|
|
inline |
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.
The documentation for this class was generated from the following file: