pynetdicom.dimse_primitives.C_GET¶
-
class
pynetdicom.dimse_primitives.
C_GET
¶ Represents a C-GET primitive.
Parameter
Req/ind
Rsp/conf
Message ID
M
U
Message ID Being Responded To
-
M
Affected SOP Class UID
M
U(=)
Priority
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 leftC - The parameter is conditional.M - MandatoryMF - Mandatory with a fixed valueU - The use of this parameter is a DIMSE service user optionUF - 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
-
Identifier
¶ A DICOM dataset of attributes to be matched against the values of the attributes in the instances of the composite objects known to the performing DIMSE service-user.
- 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-GET 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__
()¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__
()Initialize self.
Attributes
Return the Affected SOP Class UID as a UID.
Return the Identifier as io.BytesIO.
Return the Message ID value as an int.
Return the Message ID Being Responded To as an int.
Return the Number of Completed Suboperations as int.
Return the Number of Failed Suboperations as int.
Return the Number of Remaining Suboperations as int.
Return the Number of Warning Suboperations as int.
Return the Priority as an int.
REQUEST_KEYWORDS
RESPONSE_KEYWORDS
STATUS_OPTIONAL_KEYWORDS
Return the Status as an int.
Return True if the request is valid, False otherwise.
Return True if the response is valid, False otherwise.
Return the DIMSE message type as str.
-
property
AffectedSOPClassUID
Return the Affected SOP Class UID as a UID.
-
property
Identifier
Return the Identifier as io.BytesIO.
-
property
MessageID
Return the Message ID value as an int.
-
property
MessageIDBeingRespondedTo
Return the Message ID Being Responded To as an int.
-
property
NumberOfCompletedSuboperations
Return the Number of Completed Suboperations as int.
-
property
NumberOfFailedSuboperations
Return the Number of Failed Suboperations as int.
-
property
NumberOfRemainingSuboperations
Return the Number of Remaining Suboperations as int.
-
property
NumberOfWarningSuboperations
Return the Number of Warning Suboperations as int.
-
property
Priority
Return the Priority as an int.
-
property
Status
Return the Status as an int.
-
property
is_valid_request
¶ Return True if the request is valid, False otherwise.
-
property
is_valid_response
¶ Return True if the response is valid, False otherwise.
-
property
msg_type
¶ Return the DIMSE message type as str.
-