|
|
| DcmStorageSCU () |
| | default constructor
|
| |
|
virtual | ~DcmStorageSCU () |
| | destructor
|
| |
|
virtual void | clear () |
| | clear the internal member variables
|
| |
| unsigned long | getAssociationCounter () const |
| | get value of the association counter.
|
| |
| size_t | getNumberOfSOPInstances () const |
| | get number of SOP instances stored in the transfer list
|
| |
| size_t | getNumberOfSOPInstancesToBeSent () const |
| | get number of SOP instances that are to be sent (i.e. that are not yet sent).
|
| |
| E_DecompressionMode | getDecompressionMode () const |
| | get mode that specifies whether or not compressed datasets are decompressed if needed, i.e. whether the transfer syntax of the dataset is changed for network transmission.
|
| |
| OFBool | getHaltOnInvalidFileMode () const |
| | get mode that specifies whether to halt if an invalid file is encountered during batch processing (e.g. when adding SOP instances from a DICOMDIR) or whether to continue with the next SOP instance.
|
| |
| OFBool | getHaltOnUnsuccessfulStoreMode () const |
| | get mode that specifies whether to halt if unsuccessful store encountered or whether to continue with the next SOP instance.
|
| |
| OFBool | getAllowIllegalProposalMode () const |
| | get mode that specifies whether to propose presentation contexts that do not contain the default transfer syntax although it is needed, which might result in a violation of the DICOM standard.
|
| |
| OFBool | getReadFromDICOMDIRMode () const |
| | get mode that specifies whether to read information on SOP instances to be sent from the DICOMDIR files that are added to the transfer list.
|
| |
| OFBool | getMOVEOriginatorInfo (OFString &aeTitle, Uint16 &messageID) const |
| | get C-MOVE originator information (if set)
|
| |
| void | setDecompressionMode (const E_DecompressionMode decompressionMode) |
| | set mode that specifies whether or not compressed datasets are decompressed if needed, i.e. whether the transfer syntax of the dataset is changed for network transmission.
|
| |
| void | setHaltOnInvalidFileMode (const OFBool haltMode) |
| | set mode that specifies whether to halt if an invalid file is encountered during batch processing (e.g. when adding SOP instances from a DICOMDIR) or whether to continue with the next SOP instance.
|
| |
| void | setHaltOnUnsuccessfulStoreMode (const OFBool haltMode) |
| | set mode that specifies whether to halt if unsuccessful store encountered or whether to continue with the next SOP instance.
|
| |
| void | setAllowIllegalProposalMode (const OFBool allowMode) |
| | set mode that specifies whether to propose presentation contexts that do not contain the default transfer syntax, although it is needed, which might result in a violation of the DICOM standard.
|
| |
| void | setReadFromDICOMDIRMode (const OFBool readMode) |
| | set mode that specifies whether to read information on SOP instances to be sent from the DICOMDIR files that are added to the transfer list.
|
| |
| void | setMOVEOriginatorInfo (const OFString &aeTitle="", const Uint16 messageID=0) |
| | set C-MOVE originator information.
|
| |
| void | resetSentStatus (const OFBool sameAssociation=OFFalse) |
| | reset the sent status for all SOP instances in the transfer list.
|
| |
| void | removeAllSOPInstances () |
| | remove all SOP instances from the transfer list.
|
| |
| OFCondition | removeSOPInstance (const OFString &sopClassUID, const OFString &sopInstanceUID, const OFBool allOccurrences=OFTrue) |
| | remove a particular SOP instance from the transfer list.
|
| |
| OFCondition | addDicomFile (const OFFilename &filename, const E_FileReadMode readMode=ERM_fileOnly, const OFBool checkValues=OFTrue) |
| | add a SOP instance stored as a DICOM file or a number of SOP instances referenced from a DICOMDIR to the list of instances to be transferred.
|
| |
| OFCondition | addDataset (DcmDataset *dataset, const E_TransferSyntax datasetXfer=EXS_Unknown, const E_HandlingMode handlingMode=HM_compactAfterSend, const OFBool checkValues=OFTrue) |
| | add a SOP instance from a given DICOM dataset to the list of instances to be transferred.
|
| |
| OFCondition | addPresentationContexts () |
| | add presentation contexts for all SOP instances in the transfer list, which were not yet sent (either successfully or unsuccessfully).
|
| |
| virtual OFCondition | negotiateAssociation () |
| | negotiate association by using presentation contexts and parameters as defined by earlier method calls.
|
| |
| OFCondition | sendSOPInstances () |
| | send SOP instances to be transferred to the specified peer.
|
| |
| void | getStatusSummary (OFString &summary) const |
| | get some status information on the overall sending process.
|
| |
| OFCondition | createReportFile (const OFString &filename) const |
| | create a text file with a detailed report on the transfer of DICOM SOP instances.
|
| |
|
| DcmSCU () |
| | Constructor, just initializes internal class members.
|
| |
|
virtual | ~DcmSCU () |
| | Virtual destructor.
|
| |
| OFCondition | addPresentationContext (const OFString &abstractSyntax, const OFList< OFString > &xferSyntaxes, const T_ASC_SC_ROLE role=ASC_SC_ROLE_DEFAULT) |
| | Add presentation context to be used for association negotiation.
|
| |
| virtual OFCondition | initNetwork () |
| | Initialize network, i.e. prepare for association negotiation.
|
| |
| T_ASC_PresentationContextID | findPresentationContextID (const OFString &abstractSyntax, const OFString &transferSyntax, const T_ASC_SC_ROLE requestorRole=ASC_SC_ROLE_DEFAULT) |
| | After negotiation association, this call returns the first usable presentation context given the desired abstract syntax and transfer syntax.
|
| |
| T_ASC_PresentationContextID | findAnyPresentationContextID (const OFString &abstractSyntax, const OFString &transferSyntax) |
| | After a successful association negotiation, this function is called to return the presentation context ID that best matches the desired abstract syntax and transfer syntax (TS).
|
| |
| virtual OFCondition | sendECHORequest (const T_ASC_PresentationContextID presID) |
| | This function sends a C-ECHO command via network to another DICOM application.
|
| |
| virtual OFCondition | sendSTORERequest (const T_ASC_PresentationContextID presID, const OFFilename &dicomFile, DcmDataset *dataset, Uint16 &rspStatusCode, const OFString &moveOriginatorAETitle="", const Uint16 moveOriginatorMsgID=0) |
| | This function sends a C-STORE request on the currently opened association and receives the corresponding response then.
|
| |
| virtual OFCondition | sendMOVERequest (const T_ASC_PresentationContextID presID, const OFString &moveDestinationAETitle, DcmDataset *dataset, OFList< RetrieveResponse * > *responses) |
| | Sends a C-MOVE Request on given presentation context and receives list of responses.
|
| |
| virtual OFCondition | handleMOVEResponse (const T_ASC_PresentationContextID presID, RetrieveResponse *response, OFBool &waitForNextResponse) |
| | This is the standard handler for C-MOVE message responses: It just adds up all responses it receives and prints a DEBUG message.
|
| |
| virtual OFCondition | sendCGETRequest (const T_ASC_PresentationContextID presID, DcmDataset *dataset, OFList< RetrieveResponse * > *responses) |
| | Sends a C-GET Request on given presentation context and receives list of responses.
|
| |
| virtual OFCondition | handleCGETSession (const T_ASC_PresentationContextID presID, DcmDataset *dataset, OFList< RetrieveResponse * > *responses) |
| | Does the logic for switching between C-GET Response and C-STORE Requests.
|
| |
| virtual OFCondition | handleCGETResponse (const T_ASC_PresentationContextID presID, RetrieveResponse *response, OFBool &continueCGETSession) |
| | Function handling a single C-GET Response.
|
| |
| virtual OFCondition | handleSTORERequest (const T_ASC_PresentationContextID presID, DcmDataset *incomingObject, OFBool &continueCGETSession, Uint16 &cStoreReturnStatus) |
| | Function handling a single C-STORE Request.
|
| |
| virtual OFCondition | handleSTORERequestFile (T_ASC_PresentationContextID *presID, const OFString &filename, T_DIMSE_C_StoreRQ *request) |
| | Function handling a single C-STORE Request.
|
| |
| virtual OFCondition | sendFINDRequest (const T_ASC_PresentationContextID presID, DcmDataset *queryKeys, OFList< QRResponse * > *responses) |
| | Sends a C-FIND Request on given presentation context and receives list of responses.
|
| |
| virtual OFCondition | handleFINDResponse (const T_ASC_PresentationContextID presID, QRResponse *response, OFBool &waitForNextResponse) |
| | This is the standard handler for C-FIND message responses: It just adds up all responses it receives and prints a DEBUG message.
|
| |
| virtual OFCondition | sendCANCELRequest (const T_ASC_PresentationContextID presID, const Sint32 msgIDBeingRespondedTo=-1) |
| | Send C-CANCEL and, therefore, ends the C-FIND -GET or -MOVE session, i.e. no further responses will be handled.
|
| |
| virtual OFCondition | sendACTIONRequest (const T_ASC_PresentationContextID presID, const OFString &sopInstanceUID, const Uint16 actionTypeID, DcmDataset *reqDataset, Uint16 &rspStatusCode) |
| | This function sends a N-ACTION request on the currently opened association and receives the corresponding response then.
|
| |
| virtual OFCondition | sendEVENTREPORTRequest (const T_ASC_PresentationContextID presID, const OFString &sopInstanceUID, const Uint16 eventTypeID, DcmDataset *reqDataset, Uint16 &rspStatusCode) |
| | This function sends N-EVENT-REPORT request and receives the corresponding response.
|
| |
| virtual OFCondition | handleEVENTREPORTRequest (DcmDataset *&reqDataset, Uint16 &eventTypeID, const int timeout=0) |
| | Receives N-EVENT-REPORT request on the currently opened association and sends a corresponding response.
|
| |
| virtual OFCondition | sendNCREATERequest (const T_ASC_PresentationContextID presID, const OFString &affectedSopInstanceUID, DcmDataset *reqDataset, DcmDataset *&createdInstance, Uint16 &rspStatusCode) |
| | This function sends N-CREATE request and receives the corresponding response.
|
| |
| virtual OFCondition | sendNSETRequest (const T_ASC_PresentationContextID presID, const OFString &requestedSopInstanceUID, DcmDataset *modificationList, DcmDataset *&attributeList, Uint16 &rspStatusCode) |
| | This function sends N-SET request and receives the corresponding response.
|
| |
| virtual OFCondition | handleSessionResponseDefault (const Uint16 dimseStatus, const OFString &message, OFBool &waitForNextResponse) |
| | Function handling a single C-GET, C-FIND or C-MOVE Response, used by handleCGETResponse(), handleFINDResponse() and handleMOVEResponse().
|
| |
| virtual void | closeAssociation (const DcmCloseAssociationType closeType) |
| | Closes the association created by this SCU.
|
| |
| virtual OFCondition | releaseAssociation () |
| | Releases the current association by sending an A-RELEASE request to the SCP.
|
| |
| virtual OFCondition | abortAssociation () |
| | Aborts the current association by sending an A-ABORT request to the SCP.
|
| |
| void | setMaxReceivePDULength (const Uint32 maxRecPDU) |
| | Set maximum PDU length (to be received by SCU)
|
| |
| void | setDIMSEBlockingMode (const T_DIMSE_BlockingMode blockingMode) |
| | Set whether to send in DIMSE blocking or non-blocking mode.
|
| |
| void | setAETitle (const OFString &myAETtitle) |
| | Set SCU's AE title to be used in association negotiation.
|
| |
| void | setPeerHostName (const OFString &peerHostName) |
| | Set SCP's host (host name or IP address) to talk to in association negotiation.
|
| |
| void | setPeerAETitle (const OFString &peerAETitle) |
| | Set SCP's AE title to talk to in association negotiation.
|
| |
| void | setProtocolVersion (T_ASC_ProtocolFamily protocolVersion) |
| | Set the IP protocol version.
|
| |
| void | setPeerPort (const Uint16 peerPort) |
| | Set SCP's port number to connect to for association negotiation.
|
| |
| void | setDIMSETimeout (const Uint32 dimseTimeout) |
| | Set timeout for receiving DIMSE messages.
|
| |
| void | setACSETimeout (const Uint32 acseTimeout) |
| | Set timeout for receiving ACSE messages.
|
| |
| void | setConnectionTimeout (const Sint32 connectionTimeout) |
| | Set timeout for connecting to the SCP.
|
| |
| void | setAssocConfigFileAndProfile (const OFString &filename, const OFString &profile) |
| | Set an association configuration file and profile to be used.
|
| |
| void | setStorageDir (const OFString &storeDir) |
| | Set the directory that should be used by the standard C-GET handler to store objects that come in with the corresponding C-STORE requests.
|
| |
| void | setStorageMode (const DcmStorageMode storageMode) |
| | Set the storage mode to be used.
|
| |
| void | setVerbosePCMode (const OFBool mode) |
| | Set whether to show presentation contexts in verbose or debug mode.
|
| |
| void | setDatasetConversionMode (const OFBool mode) |
| | Set the mode that specifies whether the transfer syntax of the dataset can be changed for network transmission.
|
| |
| void | setProgressNotificationMode (const OFBool mode) |
| | Set the mode that specifies whether the progress of sending and receiving DIMSE messages is notified by calling notifySENDProgress() and notifyRECEIVEProgress(), respectively.
|
| |
| OFBool | isConnected () const |
| | Get current connection status.
|
| |
| Uint32 | getMaxReceivePDULength () const |
| | Returns maximum PDU length configured to be received by SCU.
|
| |
| T_DIMSE_BlockingMode | getDIMSEBlockingMode () const |
| | Returns whether DIMSE messaging is configured to be blocking or unblocking.
|
| |
| const OFString & | getAETitle () const |
| | Returns the SCU's own configured AE title.
|
| |
| const OFString & | getPeerHostName () const |
| | Returns the SCP's (peer's) host configured.
|
| |
| const OFString & | getPeerAETitle () const |
| | Returns the SCP's (peer's) AE title configured.
|
| |
| Uint16 | getPeerPort () const |
| | Returns the SCP's (peer's) TCP/IP port configured.
|
| |
| Uint32 | getDIMSETimeout () const |
| | Returns DIMSE timeout in seconds for receiving data.
|
| |
| Uint32 | getACSETimeout () const |
| | Returns ACSE timeout in seconds used by timer for message timeouts during association negotiation.
|
| |
| Sint32 | getConnectionTimeout () const |
| | Returns the timeout configured defining how long SCU will wait for the SCP when requesting an association.
|
| |
| OFString | getStorageDir () const |
| | Returns the storage directory used for storing objects received with C-STORE requests in the context of C-GET sessions.
|
| |
| DcmStorageMode | getStorageMode () const |
| | Returns the storage mode enabled.
|
| |
| OFBool | getVerbosePCMode () const |
| | Returns the verbose presentation context mode configured specifying whether details on the presentation contexts (negotiated during association setup) should be shown in verbose or debug mode.
|
| |
| OFBool | getDatasetConversionMode () const |
| | Returns the mode that specifies whether the transfer syntax of the dataset can be changed for network transmission.
|
| |
| OFBool | getProgressNotificationMode () const |
| | Returns the mode that specifies whether the progress of sending and receiving DIMSE messages is notified by calling notifySENDProgress() and notifyRECEIVEProgress(), respectively.
|
| |
| virtual OFBool | getTLSEnabled () const |
| | Returns whether SCU is configured to create a TLS connection with the SCP.
|
| |
|
void | freeNetwork () |
| | Deletes internal networking structures from memory.
|
| |
| OFCondition | useSecureConnection (DcmTransportLayer *tlayer) |
| | Tells DcmSCU to use a secure TLS connection described by the given TLS layer.
|
| |
|
| OFCondition | addDicomFilesFromDICOMDIR (const OFFilename &filename, const E_FileReadMode readMode, const OFBool checkValues) |
| | add SOP instances referenced from a given DICOMDIR to the list of instances to be transferred.
|
| |
| virtual OFCondition | checkSOPInstance (const OFString &sopClassUID, const OFString &sopInstanceUID, const OFString &transferSyntaxUID, const OFBool checkValues) |
| | check given SOP Class UID, SOP Instance UID and Transfer Syntax UID for validity and conformance to the DICOM standard.
|
| |
| virtual void | notifySOPInstanceToBeSent (const TransferEntry &transferEntry) |
| | this method is called each time before a SOP instance is sent to a peer.
|
| |
| virtual void | notifySOPInstanceSent (const TransferEntry &transferEntry) |
| | this method is called each time after a SOP instance has been sent to a peer.
|
| |
| virtual OFBool | shouldStopAfterCurrentSOPInstance () |
| | this method is called each time after a SOP instance is sent to a peer.
|
| |
| OFCondition | sendDIMSEMessage (const T_ASC_PresentationContextID presID, T_DIMSE_Message *msg, DcmDataset *dataObject, DcmDataset **commandSet=NULL) |
| | Sends a DIMSE command and possibly also a dataset from a data object via network to another DICOM application.
|
| |
| OFCondition | getDatasetInfo (DcmDataset *dataset, OFString &sopClassUID, OFString &sopInstanceUID, E_TransferSyntax &transferSyntax) |
| | Returns SOP Class UID, SOP Instance UID and original transfer syntax for a given dataset.
|
| |
| OFCondition | receiveDIMSECommand (T_ASC_PresentationContextID *presID, T_DIMSE_Message *msg, DcmDataset **statusDetail, DcmDataset **commandSet=NULL, const Uint32 timeout=0) |
| | Receive DIMSE command (excluding dataset!) over the currently open association.
|
| |
| OFCondition | receiveDIMSEDataset (T_ASC_PresentationContextID *presID, DcmDataset **dataObject) |
| | Receives one dataset (of instance data) via network from another DICOM application.
|
| |
| void | clearPresentationContexts () |
| | clear list of presentation contexts.
|
| |
| void | findPresentationContext (const T_ASC_PresentationContextID presID, OFString &abstractSyntax, OFString &transferSyntax) |
| | After negotiation association, this call returns the presentation context belonging to the given presentation context ID.
|
| |
| virtual void | notifyInstanceStored (const OFString &filename, const OFString &sopClassUID, const OFString &sopInstanceUID) const |
| | This function is called if an object was received due to a C-GET request and can be overwritten by a user in order to be informed about such an event.
|
| |
| virtual void | notifySENDProgress (const unsigned long byteCount) |
| | This function is called while sending DIMSE messages, i.e. on each PDV of a dataset.
|
| |
| virtual void | notifyRECEIVEProgress (const unsigned long byteCount) |
| | This function is called while receiving DIMSE messages, i.e. on each PDV of a dataset.
|
| |
| virtual Uint16 | checkEVENTREPORTRequest (T_DIMSE_N_EventReportRQ &request, DcmDataset *reqDataset) |
| | Check given N-EVENT-REPORT request and dataset for validity.
|
| |
| virtual OFCondition | sendSTOREResponse (T_ASC_PresentationContextID presID, Uint16 status, const T_DIMSE_C_StoreRQ &request) |
| | Sends back a C-STORE response on the given presentation context, with the designated status, fitting the corresponding C-STORE request.
|
| |
| virtual OFString | createStorageFilename (DcmDataset *dataset) |
| | Helper function that generates a storage filename by extracting SOP Class and SOP Instance UID from a dataset and combining that with the configured storage directory.
|
| |
| virtual OFCondition | ignoreSTORERequest (T_ASC_PresentationContextID presID, const T_DIMSE_C_StoreRQ &request) |
| | Receives a DICOM dataset on a given presentation context ID but does not store it in memory or disk, thus ignoring it.
|
| |
| virtual Uint16 | nextMessageID () |
| | Returns next available message ID free to be used by SCU.
|
| |