pynetdicom.dimse_primitives.C_MOVE

class pynetdicom.dimse_primitives.C_MOVE

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

Status

The error or success notification of the operation.

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__() → None

Methods

__init__()

Attributes

AffectedSOPClassUID	Get or set the Affected SOP Class UID as UID.
Identifier	Get or set the Identifier as io.BytesIO.
MessageID	Get or set the Message ID value as int.
MessageIDBeingRespondedTo	Get or set the Message ID Being Responded To as int.
MoveDestination	Get or set the Move Destination as str.
NumberOfCompletedSuboperations	Get or set the Number of Completed Suboperations as int.
NumberOfFailedSuboperations	Get or set the Number of Failed Suboperations as int.
NumberOfRemainingSuboperations	Get or set the Number of Remaining Suboperations as int.
NumberOfWarningSuboperations	Get or set the Number of Warning Suboperations as int.
Priority	Get or set the Priority as int.
REQUEST_KEYWORDS
RESPONSE_KEYWORDS
STATUS_OPTIONAL_KEYWORDS
Status	Get or set the Status as int.
is_valid_request	Return True if the request is valid, False otherwise.
is_valid_response	Return True if the response is valid, False otherwise.
msg_type	Return the DIMSE message type as str.

property Identifier: BytesIO | None

Get or set the Identifier as io.BytesIO.

Parameters:

io.BytesIO – The value to use for the Identifier parameter.

property MoveDestination: str | None

Get or set the Move Destination as str.

Parameters:

value (str) – The value to use for the Move Destination parameter. Cannot be an empty string.

Returns:

The Move Destination value.

Return type:

str

property NumberOfCompletedSuboperations: int | None

Get or set the Number of Completed Suboperations as int.

property NumberOfFailedSuboperations: int | None

Get or set the Number of Failed Suboperations as int.

property NumberOfRemainingSuboperations: int | None

Get or set the Number of Remaining Suboperations as int.

property NumberOfWarningSuboperations: int | None

Get or set the Number of Warning Suboperations as int.

property Priority: int

Get or set the Priority as int.

Parameters:

int –

The value to use for the Priority parameter. It shall be one of the following:

• 0: Medium

• 1: High

• 2: Low (Default)