|
PACS System 0.1.0
PACS DICOM system library
|
Classes | |
| class | dimse_message |
Typedefs | |
| template<typename T > | |
| using | dimse_result = kcenon::pacs::Result<T> |
| Result type for DIMSE operations using standardized kcenon::pacs::Result<T> | |
| using | status_code = uint16_t |
| DIMSE status code type alias. | |
Enumerations | |
| enum class | command_field : uint16_t { c_store_rq = 0x0001 , c_store_rsp = 0x8001 , c_get_rq = 0x0010 , c_get_rsp = 0x8010 , c_find_rq = 0x0020 , c_find_rsp = 0x8020 , c_move_rq = 0x0021 , c_move_rsp = 0x8021 , c_echo_rq = 0x0030 , c_echo_rsp = 0x8030 , c_cancel_rq = 0x0FFF , n_event_report_rq = 0x0100 , n_event_report_rsp = 0x8100 , n_get_rq = 0x0110 , n_get_rsp = 0x8110 , n_set_rq = 0x0120 , n_set_rsp = 0x8120 , n_action_rq = 0x0130 , n_action_rsp = 0x8130 , n_create_rq = 0x0140 , n_create_rsp = 0x8140 , n_delete_rq = 0x0150 , n_delete_rsp = 0x8150 } |
| DIMSE command field values. More... | |
| enum class | dimse_error { success = 0 , invalid_command_set , missing_required_field , invalid_data_format , encoding_error , decoding_error } |
| Error codes for DIMSE message operations. More... | |
Functions | |
| constexpr std::string_view | to_string (dimse_error err) noexcept |
| Get error description. | |
| auto | make_c_echo_rq (uint16_t message_id, std::string_view sop_class_uid="1.2.840.10008.1.1") -> dimse_message |
| Create a C-ECHO request message. | |
| auto | make_c_echo_rsp (uint16_t message_id_responded_to, status_code status=status_success, std::string_view sop_class_uid="1.2.840.10008.1.1") -> dimse_message |
| Create a C-ECHO response message. | |
| auto | make_c_store_rq (uint16_t message_id, std::string_view sop_class_uid, std::string_view sop_instance_uid, uint16_t priority=priority_medium) -> dimse_message |
| Create a C-STORE request message. | |
| auto | make_c_store_rsp (uint16_t message_id_responded_to, std::string_view sop_class_uid, std::string_view sop_instance_uid, status_code status=status_success) -> dimse_message |
| Create a C-STORE response message. | |
| auto | make_c_find_rq (uint16_t message_id, std::string_view sop_class_uid, uint16_t priority=priority_medium) -> dimse_message |
| Create a C-FIND request message. | |
| auto | make_c_find_rsp (uint16_t message_id_responded_to, std::string_view sop_class_uid, status_code status) -> dimse_message |
| Create a C-FIND response message. | |
| auto | make_n_create_rq (uint16_t message_id, std::string_view sop_class_uid, std::string_view sop_instance_uid="") -> dimse_message |
| Create an N-CREATE request message. | |
| auto | make_n_create_rsp (uint16_t message_id_responded_to, std::string_view sop_class_uid, std::string_view sop_instance_uid, status_code status=status_success) -> dimse_message |
| Create an N-CREATE response message. | |
| auto | make_n_set_rq (uint16_t message_id, std::string_view sop_class_uid, std::string_view sop_instance_uid) -> dimse_message |
| Create an N-SET request message. | |
| auto | make_n_set_rsp (uint16_t message_id_responded_to, std::string_view sop_class_uid, std::string_view sop_instance_uid, status_code status=status_success) -> dimse_message |
| Create an N-SET response message. | |
| auto | make_n_get_rq (uint16_t message_id, std::string_view sop_class_uid, std::string_view sop_instance_uid, const std::vector< core::dicom_tag > &attribute_tags={}) -> dimse_message |
| Create an N-GET request message. | |
| auto | make_n_get_rsp (uint16_t message_id_responded_to, std::string_view sop_class_uid, std::string_view sop_instance_uid, status_code status=status_success) -> dimse_message |
| Create an N-GET response message. | |
| auto | make_n_event_report_rq (uint16_t message_id, std::string_view sop_class_uid, std::string_view sop_instance_uid, uint16_t event_type_id) -> dimse_message |
| Create an N-EVENT-REPORT request message. | |
| auto | make_n_event_report_rsp (uint16_t message_id_responded_to, std::string_view sop_class_uid, std::string_view sop_instance_uid, uint16_t event_type_id, status_code status=status_success) -> dimse_message |
| Create an N-EVENT-REPORT response message. | |
| auto | make_n_action_rq (uint16_t message_id, std::string_view sop_class_uid, std::string_view sop_instance_uid, uint16_t action_type_id) -> dimse_message |
| Create an N-ACTION request message. | |
| auto | make_n_action_rsp (uint16_t message_id_responded_to, std::string_view sop_class_uid, std::string_view sop_instance_uid, uint16_t action_type_id, status_code status=status_success) -> dimse_message |
| Create an N-ACTION response message. | |
| auto | make_n_delete_rq (uint16_t message_id, std::string_view sop_class_uid, std::string_view sop_instance_uid) -> dimse_message |
| Create an N-DELETE request message. | |
| auto | make_n_delete_rsp (uint16_t message_id_responded_to, std::string_view sop_class_uid, std::string_view sop_instance_uid, status_code status=status_success) -> dimse_message |
| Create an N-DELETE response message. | |
Command Field Utilities | |
| constexpr bool | is_request (command_field cmd) noexcept |
| Check if a command field represents a request. | |
| constexpr bool | is_response (command_field cmd) noexcept |
| Check if a command field represents a response. | |
| constexpr bool | is_dimse_c (command_field cmd) noexcept |
| Check if a command is a DIMSE-C command. | |
| constexpr bool | is_dimse_n (command_field cmd) noexcept |
| Check if a command is a DIMSE-N command. | |
| constexpr command_field | get_response_command (command_field request) noexcept |
| Get the corresponding response command for a request. | |
| constexpr command_field | get_request_command (command_field response) noexcept |
| Get the corresponding request command for a response. | |
| constexpr std::string_view | to_string (command_field cmd) noexcept |
| Convert command field to string representation. | |
Status Type Categories | |
| constexpr bool | is_success (status_code status) noexcept |
| Check if status indicates success. | |
| constexpr bool | is_pending (status_code status) noexcept |
| Check if status indicates pending (more results) | |
| constexpr bool | is_cancel (status_code status) noexcept |
| Check if status indicates cancellation. | |
| constexpr bool | is_warning (status_code status) noexcept |
| Check if status indicates a warning. | |
| constexpr bool | is_failure (status_code status) noexcept |
| Check if status indicates a failure. | |
| constexpr bool | is_final (status_code status) noexcept |
| Check if this is a final status (operation complete) | |
Status Code String Conversion | |
| constexpr std::string_view | status_description (status_code status) noexcept |
| Get a human-readable description of a status code. | |
| constexpr std::string_view | status_category (status_code status) noexcept |
| Get the category name for a status code. | |
Variables | |
DIMSE Command Tags | |
| constexpr core::dicom_tag | tag_command_group_length {0x0000, 0x0000} |
| Command Group Length (0000,0000) - UL. | |
| constexpr core::dicom_tag | tag_affected_sop_class_uid {0x0000, 0x0002} |
| Affected SOP Class UID (0000,0002) - UI. | |
| constexpr core::dicom_tag | tag_requested_sop_class_uid {0x0000, 0x0003} |
| Requested SOP Class UID (0000,0003) - UI. | |
| constexpr core::dicom_tag | tag_command_field {0x0000, 0x0100} |
| Command Field (0000,0100) - US. | |
| constexpr core::dicom_tag | tag_message_id {0x0000, 0x0110} |
| Message ID (0000,0110) - US. | |
| constexpr core::dicom_tag | tag_message_id_responded_to {0x0000, 0x0120} |
| Message ID Being Responded To (0000,0120) - US. | |
| constexpr core::dicom_tag | tag_move_destination {0x0000, 0x0600} |
| Move Destination (0000,0600) - AE. | |
| constexpr core::dicom_tag | tag_priority {0x0000, 0x0700} |
| Priority (0000,0700) - US. | |
| constexpr core::dicom_tag | tag_command_data_set_type {0x0000, 0x0800} |
| Command Data Set Type (0000,0800) - US. | |
| constexpr core::dicom_tag | tag_status {0x0000, 0x0900} |
| Status (0000,0900) - US. | |
| constexpr core::dicom_tag | tag_offending_element {0x0000, 0x0901} |
| Offending Element (0000,0901) - AT. | |
| constexpr core::dicom_tag | tag_error_comment {0x0000, 0x0902} |
| Error Comment (0000,0902) - LO. | |
| constexpr core::dicom_tag | tag_error_id {0x0000, 0x0903} |
| Error ID (0000,0903) - US. | |
| constexpr core::dicom_tag | tag_affected_sop_instance_uid {0x0000, 0x1000} |
| Affected SOP Instance UID (0000,1000) - UI. | |
| constexpr core::dicom_tag | tag_requested_sop_instance_uid {0x0000, 0x1001} |
| Requested SOP Instance UID (0000,1001) - UI. | |
| constexpr core::dicom_tag | tag_event_type_id {0x0000, 0x1002} |
| Event Type ID (0000,1002) - US. | |
| constexpr core::dicom_tag | tag_attribute_identifier_list {0x0000, 0x1005} |
| Attribute Identifier List (0000,1005) - AT. | |
| constexpr core::dicom_tag | tag_action_type_id {0x0000, 0x1008} |
| Action Type ID (0000,1008) - US. | |
| constexpr core::dicom_tag | tag_number_of_remaining_subops {0x0000, 0x1020} |
| Number of Remaining Sub-operations (0000,1020) - US. | |
| constexpr core::dicom_tag | tag_number_of_completed_subops {0x0000, 0x1021} |
| Number of Completed Sub-operations (0000,1021) - US. | |
| constexpr core::dicom_tag | tag_number_of_failed_subops {0x0000, 0x1022} |
| Number of Failed Sub-operations (0000,1022) - US. | |
| constexpr core::dicom_tag | tag_number_of_warning_subops {0x0000, 0x1023} |
| Number of Warning Sub-operations (0000,1023) - US. | |
| constexpr core::dicom_tag | tag_move_originator_aet {0x0000, 0x1030} |
| Move Originator Application Entity Title (0000,1030) - AE. | |
| constexpr core::dicom_tag | tag_move_originator_message_id {0x0000, 0x1031} |
| Move Originator Message ID (0000,1031) - US. | |
Command Data Set Type Values | |
| constexpr uint16_t | command_data_set_type_null = 0x0101 |
| Null value indicating no data set present. | |
| constexpr uint16_t | command_data_set_type_present = 0x0001 |
| Value indicating data set is present (any value other than 0x0101) | |
Priority Values | |
| constexpr uint16_t | priority_low = 0x0002 |
| Low priority. | |
| constexpr uint16_t | priority_medium = 0x0000 |
| Medium priority. | |
| constexpr uint16_t | priority_high = 0x0001 |
| High priority. | |
General Status Codes | |
| constexpr status_code | status_success = 0x0000 |
| Operation completed successfully. | |
| constexpr status_code | status_pending = 0xFF00 |
| Operation pending (more results available) | |
| constexpr status_code | status_pending_warning = 0xFF01 |
| Pending with optional keys not supported. | |
| constexpr status_code | status_cancel = 0xFE00 |
| Operation was canceled. | |
Failure Status Codes (0xCxxx, 0xAxxx) | |
| constexpr status_code | status_refused_out_of_resources = 0xA700 |
| Refused: Out of resources. | |
| constexpr status_code | status_refused_out_of_resources_matches = 0xA701 |
| Refused: Out of resources - Unable to calculate number of matches. | |
| constexpr status_code | status_refused_out_of_resources_subops = 0xA702 |
| Refused: Out of resources - Unable to perform sub-operations. | |
| constexpr status_code | status_refused_move_destination_unknown = 0xA801 |
| Refused: Move destination unknown. | |
| constexpr status_code | status_refused_sop_class_not_supported = 0x0122 |
| Refused: SOP class not supported. | |
| constexpr status_code | status_error_dataset_mismatch = 0xA900 |
| Error: Data set does not match SOP class. | |
| constexpr status_code | status_error_cannot_understand = 0xC000 |
| Error: Cannot understand. | |
| constexpr status_code | status_error_unable_to_process = 0xC001 |
| Error: Unable to process. | |
| constexpr status_code | status_error_duplicate_sop_instance = 0x0111 |
| Error: Duplicate SOP instance. | |
| constexpr status_code | status_error_missing_attribute = 0x0120 |
| Error: Missing attribute. | |
| constexpr status_code | status_error_missing_attribute_value = 0x0121 |
| Error: Missing attribute value. | |
DIMSE-N Specific Failure Status Codes | |
| constexpr status_code | status_error_attribute_list_error = 0x0107 |
| Error: Attribute list error (N-CREATE) | |
| constexpr status_code | status_error_attribute_value_out_of_range = 0x0116 |
| Error: Attribute value out of range (N-SET) | |
| constexpr status_code | status_error_invalid_object_instance = 0x0117 |
| Error: Invalid object instance (N-SET, N-GET, N-ACTION, N-DELETE) | |
| constexpr status_code | status_error_no_such_sop_class = 0x0118 |
| Error: No such SOP class (All DIMSE-N) | |
| constexpr status_code | status_error_class_instance_conflict = 0x0119 |
| Error: Class-instance conflict (All DIMSE-N) | |
| constexpr status_code | status_error_not_authorized = 0x0124 |
| Error: Not authorized (All DIMSE-N) | |
| constexpr status_code | status_error_duplicate_invocation = 0x0210 |
| Error: Duplicate invocation (All DIMSE-N) | |
| constexpr status_code | status_error_unrecognized_operation = 0x0211 |
| Error: Unrecognized operation (All DIMSE-N) | |
| constexpr status_code | status_error_mistyped_argument = 0x0212 |
| Error: Mistyped argument (All DIMSE-N) | |
| constexpr status_code | status_error_resource_limitation = 0x0213 |
| Error: Resource limitation (All DIMSE-N) | |
| constexpr status_code | status_error_no_such_action_type = 0x0123 |
| Error: No such action type (N-ACTION) | |
| constexpr status_code | status_error_no_such_event_type = 0x0113 |
| Error: No such event type (N-EVENT-REPORT) | |
| constexpr status_code | status_error_processing_failure = 0x0110 |
| Error: Processing failure (All DIMSE-N) | |
Warning Status Codes (0xBxxx) | |
| constexpr status_code | status_warning_coercion = 0xB000 |
| Warning: Coercion of data elements. | |
| constexpr status_code | status_warning_dataset_mismatch = 0xB007 |
| Warning: Data set does not match SOP class (non-fatal) | |
| constexpr status_code | status_warning_elements_discarded = 0xB006 |
| Warning: Elements discarded. | |
| constexpr status_code | status_warning_subops_complete_failures = 0xB000 |
| Warning: Sub-operations complete with failures. | |
| using kcenon::pacs::network::dimse::dimse_result = kcenon::pacs::Result<T> |
Result type for DIMSE operations using standardized kcenon::pacs::Result<T>
| T | The success value type |
Definition at line 176 of file dimse_message.h.
| using kcenon::pacs::network::dimse::status_code = uint16_t |
DIMSE status code type alias.
Status codes are 16-bit unsigned integers. The high nibble indicates the status type (Success, Warning, Failure, etc.)
Definition at line 32 of file status_codes.h.
|
strong |
DIMSE command field values.
These values represent the Command Field (0000,0100) in DICOM command sets. Request commands have values in the range 0x0001-0x0FFF, while response commands have values in the range 0x8001-0x8FFF.
The pattern is: response = request | 0x8000
Definition at line 35 of file command_field.h.
|
strong |
Error codes for DIMSE message operations.
| Enumerator | |
|---|---|
| success | |
| invalid_command_set | |
| missing_required_field | |
| invalid_data_format | |
| encoding_error | |
| decoding_error | |
Definition at line 146 of file dimse_message.h.
|
nodiscardconstexprnoexcept |
Get the corresponding request command for a response.
| response | The response command field |
Definition at line 162 of file command_field.h.
|
nodiscardconstexprnoexcept |
Get the corresponding response command for a request.
| request | The request command field |
Definition at line 152 of file command_field.h.
|
nodiscardconstexprnoexcept |
Check if status indicates cancellation.
| status | The status code to check |
Definition at line 176 of file status_codes.h.
References status_cancel.
Referenced by status_category().

|
nodiscardconstexprnoexcept |
Check if a command is a DIMSE-C command.
| cmd | The command field to check |
Definition at line 129 of file command_field.h.
|
nodiscardconstexprnoexcept |
Check if a command is a DIMSE-N command.
| cmd | The command field to check |
Definition at line 140 of file command_field.h.
|
nodiscardconstexprnoexcept |
Check if status indicates a failure.
| status | The status code to check |
Failure status codes start with 0xA or 0xC in the high nibble, or have specific values like 0x01xx (DIMSE-N errors) or 0x02xx (protocol errors).
Definition at line 197 of file status_codes.h.
Referenced by status_category(), and status_description().

|
nodiscardconstexprnoexcept |
Check if this is a final status (operation complete)
| status | The status code to check |
Definition at line 208 of file status_codes.h.
References is_pending().

|
nodiscardconstexprnoexcept |
Check if status indicates pending (more results)
| status | The status code to check |
Definition at line 167 of file status_codes.h.
References status_pending_warning.
Referenced by is_final(), status_category(), and status_description().

|
nodiscardconstexprnoexcept |
Check if a command field represents a request.
| cmd | The command field to check |
Definition at line 111 of file command_field.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::decode(), and kcenon::pacs::network::dimse::dimse_message::is_request().

|
nodiscardconstexprnoexcept |
Check if a command field represents a response.
| cmd | The command field to check |
Definition at line 120 of file command_field.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::is_response().

|
nodiscardconstexprnoexcept |
Check if status indicates success.
| status | The status code to check |
Definition at line 158 of file status_codes.h.
References status_success.
Referenced by status_category(), and status_description().

|
nodiscardconstexprnoexcept |
Check if status indicates a warning.
| status | The status code to check |
Definition at line 185 of file status_codes.h.
Referenced by status_category(), and status_description().

|
nodiscard |
Create a C-ECHO request message.
| message_id | The message ID |
| sop_class_uid | The Verification SOP Class UID |
Definition at line 386 of file dimse_message.cpp.
References c_echo_rq, and kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid().
Referenced by TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), and TEST_CASE().


|
nodiscard |
Create a C-ECHO response message.
| message_id_responded_to | The message ID being responded to |
| status | The response status code |
| sop_class_uid | The Verification SOP Class UID |
Definition at line 393 of file dimse_message.cpp.
References c_echo_rsp, kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), kcenon::pacs::network::dimse::dimse_message::set_message_id_responded_to(), and kcenon::pacs::network::dimse::dimse_message::set_status().

|
nodiscard |
Create a C-FIND request message.
| message_id | The message ID |
| sop_class_uid | The Query/Retrieve SOP Class UID |
| priority | Operation priority |
Definition at line 424 of file dimse_message.cpp.
References c_find_rq, kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), and kcenon::pacs::network::dimse::dimse_message::set_priority().
Referenced by TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), and TEST_CASE().


|
nodiscard |
Create a C-FIND response message.
| message_id_responded_to | The message ID being responded to |
| sop_class_uid | The Query/Retrieve SOP Class UID |
| status | The response status code |
Definition at line 432 of file dimse_message.cpp.
References c_find_rsp, kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), kcenon::pacs::network::dimse::dimse_message::set_message_id_responded_to(), and kcenon::pacs::network::dimse::dimse_message::set_status().

|
nodiscard |
Create a C-STORE request message.
| message_id | The message ID |
| sop_class_uid | The SOP Class UID |
| sop_instance_uid | The SOP Instance UID |
| priority | Operation priority |
Definition at line 402 of file dimse_message.cpp.
References c_store_rq, kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), kcenon::pacs::network::dimse::dimse_message::set_affected_sop_instance_uid(), and kcenon::pacs::network::dimse::dimse_message::set_priority().

|
nodiscard |
Create a C-STORE response message.
| message_id_responded_to | The message ID being responded to |
| sop_class_uid | The SOP Class UID |
| sop_instance_uid | The SOP Instance UID |
| status | The response status code |
Definition at line 412 of file dimse_message.cpp.
References c_store_rsp, kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), kcenon::pacs::network::dimse::dimse_message::set_affected_sop_instance_uid(), kcenon::pacs::network::dimse::dimse_message::set_message_id_responded_to(), and kcenon::pacs::network::dimse::dimse_message::set_status().

|
nodiscard |
Create an N-ACTION request message.
| message_id | The message ID |
| sop_class_uid | The Requested SOP Class UID |
| sop_instance_uid | The Requested SOP Instance UID |
| action_type_id | The action type identifier |
Definition at line 537 of file dimse_message.cpp.
References n_action_rq, kcenon::pacs::network::dimse::dimse_message::set_action_type_id(), kcenon::pacs::network::dimse::dimse_message::set_requested_sop_class_uid(), and kcenon::pacs::network::dimse::dimse_message::set_requested_sop_instance_uid().

|
nodiscard |
Create an N-ACTION response message.
| message_id_responded_to | The message ID being responded to |
| sop_class_uid | The Affected SOP Class UID |
| sop_instance_uid | The Affected SOP Instance UID |
| action_type_id | The action type identifier |
| status | The response status code |
Definition at line 547 of file dimse_message.cpp.
References n_action_rsp, kcenon::pacs::network::dimse::dimse_message::set_action_type_id(), kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), kcenon::pacs::network::dimse::dimse_message::set_affected_sop_instance_uid(), kcenon::pacs::network::dimse::dimse_message::set_message_id_responded_to(), and kcenon::pacs::network::dimse::dimse_message::set_status().

|
nodiscard |
Create an N-CREATE request message.
| message_id | The message ID |
| sop_class_uid | The Affected SOP Class UID |
| sop_instance_uid | Optional Affected SOP Instance UID (may be generated by SCP) |
Definition at line 446 of file dimse_message.cpp.
References n_create_rq, kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), and kcenon::pacs::network::dimse::dimse_message::set_affected_sop_instance_uid().
Referenced by TEST_CASE(), TEST_CASE(), and TEST_CASE().


|
nodiscard |
Create an N-CREATE response message.
| message_id_responded_to | The message ID being responded to |
| sop_class_uid | The Affected SOP Class UID |
| sop_instance_uid | The Affected SOP Instance UID (returned by SCP) |
| status | The response status code |
Definition at line 456 of file dimse_message.cpp.
References n_create_rsp, kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), kcenon::pacs::network::dimse::dimse_message::set_affected_sop_instance_uid(), kcenon::pacs::network::dimse::dimse_message::set_message_id_responded_to(), and kcenon::pacs::network::dimse::dimse_message::set_status().

|
nodiscard |
Create an N-DELETE request message.
| message_id | The message ID |
| sop_class_uid | The Requested SOP Class UID |
| sop_instance_uid | The Requested SOP Instance UID |
Definition at line 560 of file dimse_message.cpp.
References n_delete_rq, kcenon::pacs::network::dimse::dimse_message::set_requested_sop_class_uid(), and kcenon::pacs::network::dimse::dimse_message::set_requested_sop_instance_uid().

|
nodiscard |
Create an N-DELETE response message.
| message_id_responded_to | The message ID being responded to |
| sop_class_uid | The Affected SOP Class UID |
| sop_instance_uid | The Affected SOP Instance UID |
| status | The response status code |
Definition at line 568 of file dimse_message.cpp.
References n_delete_rsp, kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), kcenon::pacs::network::dimse::dimse_message::set_affected_sop_instance_uid(), kcenon::pacs::network::dimse::dimse_message::set_message_id_responded_to(), and kcenon::pacs::network::dimse::dimse_message::set_status().

|
nodiscard |
Create an N-EVENT-REPORT request message.
| message_id | The message ID |
| sop_class_uid | The Affected SOP Class UID |
| sop_instance_uid | The Affected SOP Instance UID |
| event_type_id | The event type identifier |
Definition at line 513 of file dimse_message.cpp.
References n_event_report_rq, kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), kcenon::pacs::network::dimse::dimse_message::set_affected_sop_instance_uid(), and kcenon::pacs::network::dimse::dimse_message::set_event_type_id().

|
nodiscard |
Create an N-EVENT-REPORT response message.
| message_id_responded_to | The message ID being responded to |
| sop_class_uid | The Affected SOP Class UID |
| sop_instance_uid | The Affected SOP Instance UID |
| event_type_id | The event type identifier |
| status | The response status code |
Definition at line 523 of file dimse_message.cpp.
References n_event_report_rsp, kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), kcenon::pacs::network::dimse::dimse_message::set_affected_sop_instance_uid(), kcenon::pacs::network::dimse::dimse_message::set_event_type_id(), kcenon::pacs::network::dimse::dimse_message::set_message_id_responded_to(), and kcenon::pacs::network::dimse::dimse_message::set_status().

|
nodiscard |
Create an N-GET request message.
| message_id | The message ID |
| sop_class_uid | The Requested SOP Class UID |
| sop_instance_uid | The Requested SOP Instance UID |
| attribute_tags | Optional list of attribute tags to retrieve |
Definition at line 488 of file dimse_message.cpp.
References n_get_rq, kcenon::pacs::network::dimse::dimse_message::set_attribute_identifier_list(), kcenon::pacs::network::dimse::dimse_message::set_requested_sop_class_uid(), and kcenon::pacs::network::dimse::dimse_message::set_requested_sop_instance_uid().

|
nodiscard |
Create an N-GET response message.
| message_id_responded_to | The message ID being responded to |
| sop_class_uid | The Affected SOP Class UID |
| sop_instance_uid | The Affected SOP Instance UID |
| status | The response status code |
Definition at line 501 of file dimse_message.cpp.
References n_get_rsp, kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), kcenon::pacs::network::dimse::dimse_message::set_affected_sop_instance_uid(), kcenon::pacs::network::dimse::dimse_message::set_message_id_responded_to(), and kcenon::pacs::network::dimse::dimse_message::set_status().

|
nodiscard |
Create an N-SET request message.
| message_id | The message ID |
| sop_class_uid | The Requested SOP Class UID |
| sop_instance_uid | The Requested SOP Instance UID |
Definition at line 468 of file dimse_message.cpp.
References n_set_rq, kcenon::pacs::network::dimse::dimse_message::set_requested_sop_class_uid(), and kcenon::pacs::network::dimse::dimse_message::set_requested_sop_instance_uid().
Referenced by TEST_CASE(), TEST_CASE(), and TEST_CASE().


|
nodiscard |
Create an N-SET response message.
| message_id_responded_to | The message ID being responded to |
| sop_class_uid | The Affected SOP Class UID |
| sop_instance_uid | The Affected SOP Instance UID |
| status | The response status code |
Definition at line 476 of file dimse_message.cpp.
References n_set_rsp, kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid(), kcenon::pacs::network::dimse::dimse_message::set_affected_sop_instance_uid(), kcenon::pacs::network::dimse::dimse_message::set_message_id_responded_to(), and kcenon::pacs::network::dimse::dimse_message::set_status().

|
nodiscardconstexprnoexcept |
Get the category name for a status code.
| status | The status code to categorize |
Definition at line 292 of file status_codes.h.
References is_cancel(), is_failure(), is_pending(), is_success(), and is_warning().

|
nodiscardconstexprnoexcept |
Get a human-readable description of a status code.
| status | The status code to describe |
Definition at line 222 of file status_codes.h.
References is_failure(), is_pending(), is_success(), is_warning(), status_cancel, status_error_attribute_list_error, status_error_attribute_value_out_of_range, status_error_cannot_understand, status_error_class_instance_conflict, status_error_dataset_mismatch, status_error_duplicate_invocation, status_error_duplicate_sop_instance, status_error_invalid_object_instance, status_error_missing_attribute, status_error_missing_attribute_value, status_error_mistyped_argument, status_error_no_such_action_type, status_error_no_such_event_type, status_error_no_such_sop_class, status_error_not_authorized, status_error_processing_failure, status_error_resource_limitation, status_error_unable_to_process, status_error_unrecognized_operation, status_pending, status_pending_warning, status_refused_move_destination_unknown, status_refused_out_of_resources, status_refused_out_of_resources_matches, status_refused_out_of_resources_subops, status_refused_sop_class_not_supported, status_success, status_warning_coercion, status_warning_dataset_mismatch, and status_warning_elements_discarded.

|
nodiscardconstexprnoexcept |
Convert command field to string representation.
| cmd | The command field to convert |
Definition at line 172 of file command_field.h.
References c_cancel_rq, c_echo_rq, c_echo_rsp, c_find_rq, c_find_rsp, c_get_rq, c_get_rsp, c_move_rq, c_move_rsp, c_store_rq, c_store_rsp, n_action_rq, n_action_rsp, n_create_rq, n_create_rsp, n_delete_rq, n_delete_rsp, n_event_report_rq, n_event_report_rsp, n_get_rq, n_get_rsp, n_set_rq, and n_set_rsp.
|
nodiscardconstexprnoexcept |
Get error description.
Definition at line 158 of file dimse_message.h.
References decoding_error, encoding_error, invalid_command_set, invalid_data_format, missing_required_field, and success.
|
constexpr |
Null value indicating no data set present.
Definition at line 122 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::update_data_set_type().
|
constexpr |
Value indicating data set is present (any value other than 0x0101)
Definition at line 125 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::update_data_set_type().
|
constexpr |
High priority.
Definition at line 139 of file dimse_message.h.
|
constexpr |
Low priority.
Definition at line 133 of file dimse_message.h.
|
constexpr |
Medium priority.
Definition at line 136 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::priority().
|
constexpr |
Operation was canceled.
Definition at line 47 of file status_codes.h.
Referenced by is_cancel(), and status_description().
|
constexpr |
Error: Attribute list error (N-CREATE)
Definition at line 93 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Attribute value out of range (N-SET)
Definition at line 96 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Cannot understand.
Definition at line 73 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Class-instance conflict (All DIMSE-N)
Definition at line 105 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Data set does not match SOP class.
Definition at line 70 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Duplicate invocation (All DIMSE-N)
Definition at line 111 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Duplicate SOP instance.
Definition at line 79 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Invalid object instance (N-SET, N-GET, N-ACTION, N-DELETE)
Definition at line 99 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Missing attribute.
Definition at line 82 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Missing attribute value.
Definition at line 85 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Mistyped argument (All DIMSE-N)
Definition at line 117 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: No such action type (N-ACTION)
Definition at line 123 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: No such event type (N-EVENT-REPORT)
Definition at line 126 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: No such SOP class (All DIMSE-N)
Definition at line 102 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Not authorized (All DIMSE-N)
Definition at line 108 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Processing failure (All DIMSE-N)
Definition at line 129 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Resource limitation (All DIMSE-N)
Definition at line 120 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Unable to process.
Definition at line 76 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Error: Unrecognized operation (All DIMSE-N)
Definition at line 114 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Operation pending (more results available)
Definition at line 41 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Pending with optional keys not supported.
Definition at line 44 of file status_codes.h.
Referenced by is_pending(), and status_description().
|
constexpr |
Refused: Move destination unknown.
Definition at line 64 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Refused: Out of resources.
Definition at line 55 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Refused: Out of resources - Unable to calculate number of matches.
Definition at line 58 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Refused: Out of resources - Unable to perform sub-operations.
Definition at line 61 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Refused: SOP class not supported.
Definition at line 67 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Operation completed successfully.
Definition at line 38 of file status_codes.h.
Referenced by is_success(), status_description(), and TEST_CASE().
|
constexpr |
Warning: Coercion of data elements.
Definition at line 137 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Warning: Data set does not match SOP class (non-fatal)
Definition at line 140 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Warning: Elements discarded.
Definition at line 143 of file status_codes.h.
Referenced by status_description().
|
constexpr |
Warning: Sub-operations complete with failures.
Definition at line 146 of file status_codes.h.
|
constexpr |
Action Type ID (0000,1008) - US.
Definition at line 96 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::action_type_id(), and kcenon::pacs::network::dimse::dimse_message::set_action_type_id().
|
constexpr |
Affected SOP Class UID (0000,0002) - UI.
Definition at line 48 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::affected_sop_class_uid(), and kcenon::pacs::network::dimse::dimse_message::set_affected_sop_class_uid().
|
constexpr |
Affected SOP Instance UID (0000,1000) - UI.
Definition at line 84 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::affected_sop_instance_uid(), and kcenon::pacs::network::dimse::dimse_message::set_affected_sop_instance_uid().
|
constexpr |
Attribute Identifier List (0000,1005) - AT.
Definition at line 93 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::attribute_identifier_list(), and kcenon::pacs::network::dimse::dimse_message::set_attribute_identifier_list().
|
constexpr |
Command Data Set Type (0000,0800) - US.
Definition at line 69 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::update_data_set_type().
|
constexpr |
Command Field (0000,0100) - US.
Definition at line 54 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::decode(), kcenon::pacs::network::dimse::dimse_message::dimse_message(), and kcenon::pacs::network::dimse::dimse_message::is_valid().
|
constexpr |
Command Group Length (0000,0000) - UL.
Definition at line 45 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::update_command_group_length().
|
constexpr |
Error Comment (0000,0902) - LO.
Definition at line 78 of file dimse_message.h.
|
constexpr |
Error ID (0000,0903) - US.
Definition at line 81 of file dimse_message.h.
|
constexpr |
Event Type ID (0000,1002) - US.
Definition at line 90 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::event_type_id(), and kcenon::pacs::network::dimse::dimse_message::set_event_type_id().
|
constexpr |
Message ID (0000,0110) - US.
Definition at line 57 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::decode(), kcenon::pacs::network::dimse::dimse_message::dimse_message(), and kcenon::pacs::network::dimse::dimse_message::is_valid().
|
constexpr |
Message ID Being Responded To (0000,0120) - US.
Definition at line 60 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::message_id_responded_to(), and kcenon::pacs::network::dimse::dimse_message::set_message_id_responded_to().
|
constexpr |
Move Destination (0000,0600) - AE.
Definition at line 63 of file dimse_message.h.
Referenced by kcenon::pacs::services::retrieve_scp::get_move_destination().
|
constexpr |
Move Originator Application Entity Title (0000,1030) - AE.
Definition at line 111 of file dimse_message.h.
|
constexpr |
Move Originator Message ID (0000,1031) - US.
Definition at line 114 of file dimse_message.h.
|
constexpr |
Number of Completed Sub-operations (0000,1021) - US.
Definition at line 102 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::completed_subops(), and kcenon::pacs::network::dimse::dimse_message::set_completed_subops().
|
constexpr |
Number of Failed Sub-operations (0000,1022) - US.
Definition at line 105 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::failed_subops(), and kcenon::pacs::network::dimse::dimse_message::set_failed_subops().
|
constexpr |
Number of Remaining Sub-operations (0000,1020) - US.
Definition at line 99 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::remaining_subops(), and kcenon::pacs::network::dimse::dimse_message::set_remaining_subops().
|
constexpr |
Number of Warning Sub-operations (0000,1023) - US.
Definition at line 108 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::set_warning_subops(), and kcenon::pacs::network::dimse::dimse_message::warning_subops().
|
constexpr |
Offending Element (0000,0901) - AT.
Definition at line 75 of file dimse_message.h.
|
constexpr |
Priority (0000,0700) - US.
Definition at line 66 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::priority(), and kcenon::pacs::network::dimse::dimse_message::set_priority().
|
constexpr |
Requested SOP Class UID (0000,0003) - UI.
Definition at line 51 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::requested_sop_class_uid(), and kcenon::pacs::network::dimse::dimse_message::set_requested_sop_class_uid().
|
constexpr |
Requested SOP Instance UID (0000,1001) - UI.
Definition at line 87 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::requested_sop_instance_uid(), and kcenon::pacs::network::dimse::dimse_message::set_requested_sop_instance_uid().
|
constexpr |
Status (0000,0900) - US.
Definition at line 72 of file dimse_message.h.
Referenced by kcenon::pacs::network::dimse::dimse_message::set_status(), and kcenon::pacs::network::dimse::dimse_message::status().