Orthanc Plugin SDK
Documentation of the plugin interface of Orthanc
Typedefs | Functions
Worklists

Functions to register and manage worklists. More...

Typedefs

typedef struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
 Opaque structure to an object that represents a C-Find query.
 
typedef struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
 Opaque structure to an object that represents the answers to a C-Find query.
 
typedef OrthancPluginErrorCode(* OrthancPluginWorklistCallback) (OrthancPluginWorklistAnswers *answers, const OrthancPluginWorklistQuery *query, const char *remoteAet, const char *calledAet)
 Callback to handle the C-Find SCP requests received by Orthanc. More...
 

Functions

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...
 

Detailed Description

Typedef Documentation

typedef OrthancPluginErrorCode(* OrthancPluginWorklistCallback) (OrthancPluginWorklistAnswers *answers, const OrthancPluginWorklistQuery *query, const char *remoteAet, const char *calledAet)

Signature of a callback function that is triggered when Orthanc receives a C-Find SCP request against modality worklists.

Parameters
answersThe target structure where answers must be stored.
queryThe worklist query.
remoteAetThe Application Entity Title (AET) of the modality from which the request originates.
calledAetThe Application Entity Title (AET) of the modality that is called by the request.
Returns
0 if success, other value if error.

Function Documentation

OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback ( OrthancPluginContext context,
OrthancPluginWorklistCallback  callback 
)

This function registers a callback to handle C-Find SCP requests on modality worklists.

Parameters
contextThe Orthanc plugin context, as received by OrthancPluginInitialize().
callbackThe callback.
Returns
0 if success, other value if error.
OrthancPluginErrorCode OrthancPluginWorklistAddAnswer ( OrthancPluginContext context,
OrthancPluginWorklistAnswers answers,
const OrthancPluginWorklistQuery query,
const void *  dicom,
uint32_t  size 
)

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
contextThe Orthanc plugin context, as received by OrthancPluginInitialize().
answersThe set of answers.
queryThe worklist query, as received by the callback.
dicomThe worklist to answer, encoded as a DICOM file.
sizeThe size of the DICOM file.
Returns
0 if success, other value if error.
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery ( OrthancPluginContext context,
OrthancPluginMemoryBuffer target,
const OrthancPluginWorklistQuery query 
)

This function retrieves the DICOM file that underlies a C-Find SCP query against modality worklists.

Parameters
contextThe Orthanc plugin context, as received by OrthancPluginInitialize().
targetMemory buffer where to store the DICOM file. It must be freed with OrthancPluginFreeMemoryBuffer().
queryThe worklist query, as received by the callback.
Returns
0 if success, other value if error.
int32_t OrthancPluginWorklistIsMatch ( OrthancPluginContext context,
const OrthancPluginWorklistQuery query,
const void *  dicom,
uint32_t  size 
)

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
contextThe Orthanc plugin context, as received by OrthancPluginInitialize().
queryThe worklist query, as received by the callback.
dicomThe worklist to answer, encoded as a DICOM file.
sizeThe size of the DICOM file.
Returns
1 if the worklist matches the query, 0 otherwise.
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete ( OrthancPluginContext context,
OrthancPluginWorklistAnswers answers 
)

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
contextThe Orthanc plugin context, as received by OrthancPluginInitialize().
answersThe set of answers.
Returns
0 if success, other value if error.