Functions to register and manage worklists.
More...
|
OrthancPluginErrorCode | OrthancPluginRegisterWorklistCallback (OrthancPluginContext *context, OrthancPluginWorklistCallback callback) |
| Register a callback to handle modality worklists requests. More...
|
|
OrthancPluginErrorCode | OrthancPluginWorklistAddAnswer (OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size) |
| Add one answer to some modality worklist request. More...
|
|
OrthancPluginErrorCode | OrthancPluginWorklistMarkIncomplete (OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers) |
| Mark the set of worklist answers as incomplete. More...
|
|
int32_t | OrthancPluginWorklistIsMatch (OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size) |
| Test whether a worklist matches the query. More...
|
|
OrthancPluginErrorCode | OrthancPluginWorklistGetDicomQuery (OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query) |
| Retrieve the worklist query as a DICOM file. More...
|
|
Signature of a callback function that is triggered when Orthanc receives a C-Find SCP request against modality worklists.
- Parameters
-
answers | The target structure where answers must be stored. |
query | The worklist query. |
remoteAet | The Application Entity Title (AET) of the modality from which the request originates. |
calledAet | The Application Entity Title (AET) of the modality that is called by the request. |
- Returns
- 0 if success, other value if error.
This function registers a callback to handle C-Find SCP requests on modality worklists.
- Parameters
-
context | The Orthanc plugin context, as received by OrthancPluginInitialize(). |
callback | The callback. |
- Returns
- 0 if success, other value if error.
This function adds one worklist (encoded as a DICOM file) to the set of answers corresponding to some C-Find SCP request against modality worklists.
- Parameters
-
context | The Orthanc plugin context, as received by OrthancPluginInitialize(). |
answers | The set of answers. |
query | The worklist query, as received by the callback. |
dicom | The worklist to answer, encoded as a DICOM file. |
size | The size of the DICOM file. |
- Returns
- 0 if success, other value if error.
This function retrieves the DICOM file that underlies a C-Find SCP query against modality worklists.
- Parameters
-
context | The Orthanc plugin context, as received by OrthancPluginInitialize(). |
target | Memory buffer where to store the DICOM file. It must be freed with OrthancPluginFreeMemoryBuffer(). |
query | The worklist query, as received by the callback. |
- Returns
- 0 if success, other value if error.
This function checks whether one worklist (encoded as a DICOM file) matches the C-Find SCP query against modality worklists. This function must be called before adding the worklist as an answer through OrthancPluginWorklistAddAnswer().
- Parameters
-
context | The Orthanc plugin context, as received by OrthancPluginInitialize(). |
query | The worklist query, as received by the callback. |
dicom | The worklist to answer, encoded as a DICOM file. |
size | The size of the DICOM file. |
- Returns
- 1 if the worklist matches the query, 0 otherwise.
This function marks as incomplete the set of answers corresponding to some C-Find SCP request against modality worklists. This must be used if canceling the handling of a request when too many answers are to be returned.
- Parameters
-
context | The Orthanc plugin context, as received by OrthancPluginInitialize(). |
answers | The set of answers. |
- Returns
- 0 if success, other value if error.