Connection to a patient stored in Orthanc.
More...
#include <OrthancCppClient.h>
Public Member Functions |
| Patient (const Patient &other) |
| Construct a new reference to this object.
|
| Patient (::OrthancClient::OrthancConnection &connection, const ::std::string &id) |
| Create a connection to some patient.
|
| ~Patient () |
void | Reload () |
| Reload the studies of this patient.
|
LAAW_UINT32 | GetStudyCount () |
| Return the number of studies for this patient.
|
inline::OrthancClient::Study | GetStudy (LAAW_UINT32 index) |
| Get some study of this patient.
|
inline::std::string | GetId () const |
| Get the Orthanc identifier of this patient.
|
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 patient.
|
Detailed Description
This class encapsulates a connection to a patient from a remote instance of Orthanc.
Constructor & Destructor Documentation
OrthancClient::Patient::Patient |
( |
const Patient & |
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 patient.
- Parameters
-
connection | The remote instance of Orthanc. |
id | The Orthanc identifier of the patient. |
OrthancClient::Patient::~Patient |
( |
| ) |
|
|
inline |
Member Function Documentation
std::string OrthancClient::Patient::GetId |
( |
| ) |
const |
|
inline |
Get the Orthanc identifier of this patient.
- Returns
- The identifier.
std::string OrthancClient::Patient::GetMainDicomTag |
( |
const ::std::string & |
tag, |
|
|
const ::std::string & |
defaultValue |
|
) |
| const |
|
inline |
Get the value of one of the main DICOM tags for this patient.
- Parameters
-
tag | The name of the tag of interest ("PatientName", "PatientID", "PatientSex" or "PatientBirthDate"). |
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 study. The studies are indexed by a number between 0 (inclusive) and the result of GetStudyCount() (exclusive).
- Parameters
-
index | The index of the study of interest. |
- Returns
- The study.
LAAW_UINT32 OrthancClient::Patient::GetStudyCount |
( |
| ) |
|
|
inline |
Return the number of studies for this patient.
- Returns
- The number of studies.
void OrthancClient::Patient::Reload |
( |
| ) |
|
|
inline |
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.
The documentation for this class was generated from the following file: