pynetdicom.dimse_primitives.C_MOVE

class pynetdicom.dimse_primitives.C_MOVE[source][source]

Represents a C-MOVE primitive.

Parameter Req/ind Rsp/conf
Message ID M U
Message ID Being Responded To - M
Affected SOP Class UID M U(=)
Priority M -
Move Destination M -
Identifier M U
Status - M
Number of Remaining Sub-ops - C
Number of Completed Sub-ops - C
Number of Failed Sub-ops - C
Number of Warning Sub-ops - C
Offending Element - C
Error Comment - C
(=) - The value of the parameter is equal to the value of the parameter in the column to the left
C - The parameter is conditional.
M - Mandatory
MF - Mandatory with a fixed value
U - The use of this parameter is a DIMSE service user option
UF - User option with a fixed value
MessageID

Identifies the operation and is used to distinguish this operation from other notifications or operations that may be in progress. No two identical values for the Message ID shall be used for outstanding operations.

Type:int
MessageIDBeingRespondedTo

The Message ID of the operation request/indication to which this response/confirmation applies.

Type:int
AffectedSOPClassUID

For the request/indication this specifies the SOP Class for storage. If included in the response/confirmation, it shall be equal to the value in the request/indication

Type:pydicom.uid.UID, bytes or str
Priority

The priority of the C-STORE operation. It shall be one of the following:

  • 0: Medium
  • 1: High
  • 2: Low (Default)
Type:int
MoveDestination

Specifies the DICOM AE Title of the destination DICOM AE to which the C-STORE sub-operations are being performed.

Type:bytes or str
Identifier

The pydicom Dataset containing the list of Attributes to be matched against the values of Attributes of known composite SOP Instances of the performing DIMSE service-user, encoded as a BytesIO object. For the list of allowed Attributes and the rules defining their usage see the section corresponding to the service class in the DICOM Standard, Part 4.

Type:io.BytesIO
Status

The error or success notification of the operation.

Type:int
NumberOfRemainingSuboperations

The number of remaining C-STORE sub-operations to be invoked by this C-MOVE operation. It may be included in any response and shall be included if the status is Pending

Type:int
NumberOfCompletedSuboperations

The number of C-STORE sub-operations that have completed successfully. It may be included in any response and shall be included if the status is Pending

Type:int
NumberOfFailedSuboperations

The number of C-STORE sub-operations that have failed. It may be included in any response and shall be included if the status is Pending

Type:int
NumberOfWarningSuboperations

The number of C-STORE operations that generated Warning responses. It may be included in any response and shall be included if the status is Pending

Type:int
OffendingElement

An optional status related field containing a list of the elements in which an error was detected.

Type:list of int or None
ErrorComment

An optional status related field containing a text description of the error detected. 64 characters maximum.

Type:str or None
__init__()[source][source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__() Initialize self.

Attributes

AffectedSOPClassUID Return the Affected SOP Class UID.
Identifier Return the Identifier.
MessageID Return the DIMSE Message ID.
MessageIDBeingRespondedTo Return the Message ID Being Responded To.
MoveDestination Return the Move Destination.
NumberOfCompletedSuboperations Return the Number of Completed Suboperations.
NumberOfFailedSuboperations Return the Number of Failed Suboperations.
NumberOfRemainingSuboperations Return the Number of Remaining Suboperations.
NumberOfWarningSuboperations Return the Number of Warning Suboperations.
Priority Return the Priority.
REQUEST_KEYWORDS
RESPONSE_KEYWORDS
STATUS_OPTIONAL_KEYWORDS
Status Return the Status.
is_valid_request Return True if the request is valid, False otherwise.
is_valid_response Return True if the response is valid, False otherwise.
AffectedSOPClassUID

Return the Affected SOP Class UID.

Identifier

Return the Identifier.

MessageID

Return the DIMSE Message ID.

MessageIDBeingRespondedTo

Return the Message ID Being Responded To.

MoveDestination

Return the Move Destination.

NumberOfCompletedSuboperations

Return the Number of Completed Suboperations.

NumberOfFailedSuboperations

Return the Number of Failed Suboperations.

NumberOfRemainingSuboperations

Return the Number of Remaining Suboperations.

NumberOfWarningSuboperations

Return the Number of Warning Suboperations.

Priority

Return the Priority.

Status

Return the Status.

is_valid_request

Return True if the request is valid, False otherwise.

is_valid_response

Return True if the response is valid, False otherwise.