Orthanc Client
Documentation of the client library of Orthanc
Public Member Functions | List of all members
OrthancClient::Study Class Reference

Connection to a study stored in Orthanc. More...

#include <OrthancCppClient.h>

Public Member Functions

 Study (const Study &other)
 Construct a new reference to this object. More...
 
 Study (::OrthancClient::OrthancConnection &connection, const ::std::string &id)
 Create a connection to some study. More...
 
 ~Study ()
 
void Reload ()
 Reload the series of this study. More...
 
LAAW_UINT32 GetSeriesCount ()
 Return the number of series for this study. More...
 
inline::OrthancClient::Series GetSeries (LAAW_UINT32 index)
 Get some series of this study. More...
 
inline::std::string GetId () const
 Get the Orthanc identifier of this study. More...
 
inline::std::string GetMainDicomTag (const ::std::string &tag, const ::std::string &defaultValue) const
 Get the value of one of the main DICOM tags for this study. More...
 

Detailed Description

This class encapsulates a connection to a study from a remote instance of Orthanc.

Constructor & Destructor Documentation

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
otherThe original object.
OrthancClient::Study::Study ( ::OrthancClient::OrthancConnection connection,
const ::std::string &  id 
)
inline

Create a connection to some study.

Parameters
connectionThe remote instance of Orthanc.
idThe Orthanc identifier of the study.
OrthancClient::Study::~Study ( )
inline

Destructs the object.

Member Function Documentation

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
tagThe name of the tag of interest ("StudyDate", "StudyDescription", "StudyInstanceUID" or "StudyTime").
defaultValueThe default value to be returned if this tag does not exist.
Returns
The value of the tag.
OrthancClient::Series OrthancClient::Study::GetSeries ( LAAW_UINT32  index)
inline

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
indexThe 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: