RZDCX - Fast Strike DICOM Toolkit  Release 2.0.7.4
IDCXACC Interface Reference

Use this interface to build a DICOM Service SCP (Server). More...

Inherits IDispatch.

Public Member Functions

HRESULT WaitForConnection ([in] BSTR ae_title, [in] unsigned short port, [in] int timeout, [out, retval] VARIANT_BOOL *secceeded)
 Listen on a network port and wait for incomming association. More...
 
HRESULT WaitForCommand ([in] int timeout, [out, retval] VARIANT_BOOL *secceeded)
 Call to recieve the command when an association is opened. More...
 
HRESULT TakeStoredObject ([out, retval] IDCXOBJ **obj)
 Get the last stored object. More...
 

Properties

pVal StoreDirectory [get]
 Set/Get the root folder where incoming files are saved by default The filename for stored Instances can be set at the end of a C-STORE command when the IDCXACCEvents::OnStoreDone. More...
 
VARIANT_BOOL AcceptJpegLosslessStorage [get, set]
 
VARIANT_BOOL AcceptJpegLossyStorage [get, set]
 
VARIANT_BOOL AcceptJpeg2000Storage [get, set]
 
short NextStorageResponseStatus [get, set]
 Set/Get the next or currently active storage response status. More...
 
pVal AssociationRequestTimeout [get]
 
pVal DimseCommandTimeout [get]
 

Detailed Description

Use this interface to build a DICOM Service SCP (Server).

This interface provides methods to do many SCP (server) tasks such as recieving DICOM files over a network connection. for an example of using the accepter class see CPPStorageSCPExample.cpp

Member Function Documentation

◆ TakeStoredObject()

HRESULT IDCXACC::TakeStoredObject ( [out, retval] IDCXOBJ **  obj)

Get the last stored object.

After this call, the last stored object is reset. Next call to this method will fail. Use this property in the OnStoreDone event of an in memory storage (no filename)

◆ WaitForCommand()

HRESULT IDCXACC::WaitForCommand ( [in] int  timeout,
[out, retval] VARIANT_BOOL *  secceeded 
)

Call to recieve the command when an association is opened.

Waits for an incomming command or until timeout seconds pass.

Returns
  • TRUE - A command was successfuly processed
  • FALSE - A command failed or timeout passed. If timeout passed, OnTimeout() is fired before returning.
Parameters
timeoutNumber of seconds to wait for a command
secceededTrue when a command was successfuly processed

◆ WaitForConnection()

HRESULT IDCXACC::WaitForConnection ( [in] BSTR  ae_title,
[in] unsigned short  port,
[in] int  timeout,
[out, retval] VARIANT_BOOL *  secceeded 
)

Listen on a network port and wait for incomming association.

Call WaitForConnection in an event loop to implement a Server. This method is usually called from within a while loop. WaitForConnection waits for timeout seconds for an incomming connection.

Events: The following events (callbacks) may be fired by WaitForConnection

  1. OnConnection() is called when an association request is received
Returns
The method returns in one of these cases:
  1. TRUE - An association was accepted, you should now call WaitForCommand to server the commands.
  2. FALSE - The timeout passed without any incomming association or an unsuccessful connection was made
Parameters
ae_titleThe AE Title of this application. Callers are expected to use it as 'Called AE Title'. You can verify it by implementing OnConnection
portThe network port to listen on for incomming connections
timeoutHow many seconds to wait for incomming connection before returning.
secceededTrue when an association was accepted

Property Documentation

◆ AcceptJpeg2000Storage

VARIANT_BOOL IDCXACC::AcceptJpeg2000Storage
getsetproperty

Enable/Disable Storage SCP association negotiation JPEG 2000 Transfer Syntaxes:

DICOM Conformance:
When true, accepts the following transfer syntxes for all Storage SOP classes
  • 1.2.840.10008.1.2.4.90
  • 1.2.840.10008.1.2.4.91
  • 1.2.840.10008.1.2.4.92
  • 1.2.840.10008.1.2.4.93 Control:
  • TRUE - JPEG 2000 Transfer Syntaxes are accepted
  • FALSE - JPEG 2000 Transfer Syntaxes are rejected

◆ AcceptJpegLosslessStorage

VARIANT_BOOL IDCXACC::AcceptJpegLosslessStorage
getsetproperty

Enable/Disable Storage SCP association negotiation JPEG Lossless Transfer Syntaxes:

DICOM Conformance:
When true, accepts the following transfer syntxes for all Storage SOP classes
  • 1.2.840.10008.1.2.4.57
  • 1.2.840.10008.1.2.4.70 Control:
  • TRUE - JPEG Lossless Transfer Syntaxes are accepted
  • FALSE - JPEG Lossless Transfer Syntaxes are rejected

◆ AcceptJpegLossyStorage

VARIANT_BOOL IDCXACC::AcceptJpegLossyStorage
getsetproperty

Enable/Disable Storage SCP association negotiation JPEG (Lossy) Transfer Syntaxes:

DICOM Conformance:
When true, accepts the following transfer syntxes for all Storage SOP classes
  • 1.2.840.10008.1.2.4.50
  • 1.2.840.10008.1.2.4.51 Control:
  • TRUE - JPEG (Lossy) Transfer Syntaxes are accepted
  • FALSE - JPEG (Lossy) Transfer Syntaxes are rejected

◆ AssociationRequestTimeout [1/2]

pVal IDCXACC::AssociationRequestTimeout
getproperty

Association Request Timeout (ARTM) is the time to wait for a response after sending A-ASSOCIATE commands The timeout set here affects only this instance

◆ AssociationRequestTimeout [2/2]

newVal IDCXACC::AssociationRequestTimeout
setproperty

◆ DimseCommandTimeout [1/2]

pVal IDCXACC::DimseCommandTimeout
getproperty

DIMSE Command Timeout is the time to wait for a response after sending a DICOM Message Exchange Command The timeout set here affects only this instance

◆ DimseCommandTimeout [2/2]

newVal IDCXACC::DimseCommandTimeout
setproperty

◆ NextStorageResponseStatus

short IDCXACC::NextStorageResponseStatus
getsetproperty

Set/Get the next or currently active storage response status.

This propery can be used to override the currently active or the next comming storage command of the active assoication of the accepter. It can be used for teaching or training to simulate error responses.

◆ StoreDirectory [1/2]

pVal IDCXACC::StoreDirectory
getproperty

Set/Get the root folder where incoming files are saved by default The filename for stored Instances can be set at the end of a C-STORE command when the IDCXACCEvents::OnStoreDone.

◆ StoreDirectory [2/2]

newVal IDCXACC::StoreDirectory
setproperty