pynetdicom.pdu_items.UserIdentitySubItemRQ

class pynetdicom.pdu_items.UserIdentitySubItemRQ[source]

A User Identity (RQ) Sub-item.

A User Identity (RQ) Sub-item is used to notify the association acceptor of the user identity of the requestor.

Notes

A User Identity (RQ) Sub-item requires the following parameters:

  • Item type (1, fixed, 0x58)

  • Item length (1)

  • User identity type (1)

  • Positive response requested (1)

  • Primary field length (1)

  • Primary field (1)

  • Secondary field length (1)

  • Secondary field (only if user identity type = 2)

Encoding

When encoded, a User Identity (RQ) Sub-item has the following structure, taken from Tables D.3-14 of the DICOM Standard (offsets shown with Python indexing). Items are always encoded using Big Endian.

Offset

Length

Description

0

1

Item type

1

1

Reserved

2

2

Item length

4

1

User identity type

5

1

Positive response requested

6

2

Primary field length

8

Variable

Primary field

8 + Primary field length

2

Secondary field length

10 + Primary field length

Variable

Secondary field

References

__init__() None[source]

Initialise a new User Identity (RQ) Item.

Methods

__init__()

Initialise a new User Identity (RQ) Item.

decode(bytestream)

Decode bytestream and use the result to set the field values of the PDU item.

encode()

Return the encoded PDU as bytes.

from_primitive(primitive)

Set the item's values using an User Identity primitive.

to_primitive()

Return an User Identity primitive from the current Item.

Attributes

id_type

Return the item's User Identity Type field value.

id_type_str

Return a string description of the User Identity Type field.

item_length

Return the item's Item Length field value as int.

item_type

Return the item's Item Type field value as int.

primary

Return the item's Primary Field field value as bytes.

primary_field_length

Return the item's Primary Field Length field value.

response_requested

Return the item's Positive Response Requested field value as bool.

secondary

Return the item's Secondary Field field value.

secondary_field_length

Return the item's Secondary Field Length field value.

from_primitive(primitive: UserIdentityNegotiation) None[source]

Set the item’s values using an User Identity primitive.

Parameters

primitive (pdu_primitives.UserIdentityNegotiation) – The primitive to use to set the Item’s field values.

property id_type: Optional[int]

Return the item’s User Identity Type field value.

property id_type_str: str

Return a string description of the User Identity Type field.

property item_length: int

Return the item’s Item Length field value as int.

property primary: Optional[bytes]

Return the item’s Primary Field field value as bytes.

property primary_field_length: int

Return the item’s Primary Field Length field value.

property response_requested: Optional[bool]

Return the item’s Positive Response Requested field value as bool.

property secondary: Optional[bytes]

Return the item’s Secondary Field field value.

property secondary_field_length: int

Return the item’s Secondary Field Length field value.

to_primitive() UserIdentityNegotiation[source]

Return an User Identity primitive from the current Item.

Returns

The primitive representation of the current Item.

Return type

pdu_primitives.UserIdentityNegotiation