Connection to an instance of Orthanc.
More...
#include <OrthancCppClient.h>
Public Member Functions |
| OrthancConnection (const OrthancConnection &other) |
| Construct a new reference to this object.
|
| OrthancConnection (const ::std::string &orthancUrl) |
| Create a connection to an instance of Orthanc.
|
| OrthancConnection (const ::std::string &orthancUrl, const ::std::string &username, const ::std::string &password) |
| Create a connection to an instance of Orthanc, with authentication.
|
| ~OrthancConnection () |
LAAW_UINT32 | GetThreadCount () const |
| Returns the number of threads for this connection.
|
void | SetThreadCount (LAAW_UINT32 threadCount) |
| Sets the number of threads for this connection.
|
void | Reload () |
| Reload the list of the patients.
|
inline::std::string | GetOrthancUrl () const |
| Returns the URL of this instance of Orthanc.
|
LAAW_UINT32 | GetPatientCount () |
| Returns the number of patients.
|
inline::OrthancClient::Patient | GetPatient (LAAW_UINT32 index) |
| Get some patient.
|
void | DeletePatient (LAAW_UINT32 index) |
| Delete some patient.
|
void | StoreFile (const ::std::string &filename) |
| Send a DICOM file.
|
void | Store (const void *dicom, LAAW_UINT64 size) |
| Send a DICOM file that is contained inside a memory buffer.
|
Detailed Description
This class encapsulates a connection to a remote instance of Orthanc through its REST API.
Constructor & Destructor Documentation
OrthancClient::OrthancConnection::OrthancConnection |
( |
const OrthancConnection & |
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. |
OrthancClient::OrthancConnection::OrthancConnection |
( |
const ::std::string & |
orthancUrl | ) |
|
|
inline |
Create a connection to an instance of Orthanc.
- Parameters
-
orthancUrl | URL to which the REST API of Orthanc is listening. |
OrthancClient::OrthancConnection::OrthancConnection |
( |
const ::std::string & |
orthancUrl, |
|
|
const ::std::string & |
username, |
|
|
const ::std::string & |
password |
|
) |
| |
|
inline |
Create a connection to an instance of Orthanc, with authentication.
- Parameters
-
orthancUrl | URL to which the REST API of Orthanc is listening. |
username | The username. |
password | The password. |
OrthancClient::OrthancConnection::~OrthancConnection |
( |
| ) |
|
|
inline |
Member Function Documentation
void OrthancClient::OrthancConnection::DeletePatient |
( |
LAAW_UINT32 |
index | ) |
|
|
inline |
Delete some patient from the remote instance of Orthanc. Pay attention to the fact that the patients that have been previously returned by GetPatient() will be invalidated.
- Parameters
-
index | The index of the patient of interest. |
- Returns
- The patient.
std::string OrthancClient::OrthancConnection::GetOrthancUrl |
( |
| ) |
const |
|
inline |
Returns the URL of the remote Orthanc instance to which this object is connected.
- Returns
- The URL.
This method will return an object that contains information about some patient. The patients are indexed by a number between 0 (inclusive) and the result of GetPatientCount() (exclusive).
- Parameters
-
index | The index of the patient of interest. |
- Returns
- The patient.
LAAW_UINT32 OrthancClient::OrthancConnection::GetPatientCount |
( |
| ) |
|
|
inline |
Returns the number of patients that are stored in the remote instance of Orthanc.
- Returns
- The number of patients.
LAAW_UINT32 OrthancClient::OrthancConnection::GetThreadCount |
( |
| ) |
const |
|
inline |
Returns the number of simultaneous connections that are used when downloading information from this instance of Orthanc.
- Returns
- The number of threads.
void OrthancClient::OrthancConnection::Reload |
( |
| ) |
|
|
inline |
This method will reload the list of the patients from the remote instance of Orthanc. Pay attention to the fact that the patients that have been previously returned by GetPatient() will be invalidated.
void OrthancClient::OrthancConnection::SetThreadCount |
( |
LAAW_UINT32 |
threadCount | ) |
|
|
inline |
Sets the number of simultaneous connections that are used when downloading information from this instance of Orthanc.
- Parameters
-
threadCount | The number of threads. |
void OrthancClient::OrthancConnection::Store |
( |
const void * |
dicom, |
|
|
LAAW_UINT64 |
size |
|
) |
| |
|
inline |
This method will store a DICOM file in the remote instance of Orthanc. Pay attention to the fact that the patients that have been previously returned by GetPatient() will be invalidated.
- Parameters
-
dicom | The memory buffer containing the DICOM file. |
size | The size of the DICOM file. |
void OrthancClient::OrthancConnection::StoreFile |
( |
const ::std::string & |
filename | ) |
|
|
inline |
This method will store a DICOM file in the remote instance of Orthanc. Pay attention to the fact that the patients that have been previously returned by GetPatient() will be invalidated.
- Parameters
-
filename | Path to the DICOM file |
The documentation for this class was generated from the following file: