kcenon::pacs::services::ups_result Struct Reference

Result of a UPS SCU operation. More...

#include <ups_push_scu.h>

Collaboration diagram for kcenon::pacs::services::ups_result:

Public Member Functions
bool	is_success () const noexcept
	Check if the operation was successful.
bool	is_warning () const noexcept
	Check if this was a warning status.
bool	is_error () const noexcept
	Check if this was an error status.

Public Attributes
std::string	workitem_uid
	Workitem SOP Instance UID.
uint16_t	status {0}
	DIMSE status code (0x0000 = success)
std::string	error_comment
	Error comment from the SCP (if any)
core::dicom_dataset	attributes
	Response dataset (for N-GET operations)
std::chrono::milliseconds	elapsed {0}
	Time taken for the operation.

Detailed Description

Result of a UPS SCU operation.

Contains information about the outcome of any UPS DIMSE-N operation.

Definition at line 124 of file ups_push_scu.h.

Member Function Documentation

is_error()

bool kcenon::pacs::services::ups_result::is_error ( ) const

inlinenodiscardnoexcept

Check if this was an error status.

Definition at line 151 of file ups_push_scu.h.

                                                 {
        return !is_success() && !is_warning();
    }

References is_success(), and is_warning().

Here is the call graph for this function:

is_success()

bool kcenon::pacs::services::ups_result::is_success ( ) const

inlinenodiscardnoexcept

Check if the operation was successful.

Definition at line 141 of file ups_push_scu.h.

                                                   {
        return status == 0x0000;
    }

References status.

Referenced by kcenon::pacs::services::ups_push_scu::change_state(), kcenon::pacs::services::ups_push_scu::create(), kcenon::pacs::services::ups_push_scu::get(), is_error(), kcenon::pacs::services::ups_push_scu::request_cancel(), kcenon::pacs::services::ups_watch_scu::send_watch_action(), and kcenon::pacs::services::ups_push_scu::set().

Here is the caller graph for this function:

is_warning()

bool kcenon::pacs::services::ups_result::is_warning ( ) const

inlinenodiscardnoexcept

Check if this was a warning status.

Definition at line 146 of file ups_push_scu.h.

                                                   {
        return (status & 0xF000) == 0xB000;
    }

References status.

Referenced by is_error().

Here is the caller graph for this function:

Member Data Documentation

attributes

core::dicom_dataset kcenon::pacs::services::ups_result::attributes

Response dataset (for N-GET operations)

Definition at line 135 of file ups_push_scu.h.

Referenced by kcenon::pacs::services::ups_push_scu::get().

elapsed

std::chrono::milliseconds kcenon::pacs::services::ups_result::elapsed {0}

Time taken for the operation.

Definition at line 138 of file ups_push_scu.h.

{0};

Referenced by kcenon::pacs::services::ups_push_scu::change_state(), kcenon::pacs::services::ups_push_scu::create(), kcenon::pacs::services::ups_push_scu::get(), kcenon::pacs::services::ups_push_scu::request_cancel(), kcenon::pacs::services::ups_watch_scu::send_watch_action(), and kcenon::pacs::services::ups_push_scu::set().

error_comment

std::string kcenon::pacs::services::ups_result::error_comment

Error comment from the SCP (if any)

Definition at line 132 of file ups_push_scu.h.

Referenced by kcenon::pacs::services::ups_push_scu::change_state(), kcenon::pacs::services::ups_push_scu::create(), kcenon::pacs::services::ups_push_scu::get(), kcenon::pacs::services::ups_push_scu::request_cancel(), kcenon::pacs::services::ups_watch_scu::send_watch_action(), and kcenon::pacs::services::ups_push_scu::set().

status

uint16_t kcenon::pacs::services::ups_result::status {0}

DIMSE status code (0x0000 = success)

Definition at line 129 of file ups_push_scu.h.

{0};

Referenced by kcenon::pacs::services::ups_push_scu::change_state(), kcenon::pacs::services::ups_push_scu::create(), kcenon::pacs::services::ups_push_scu::get(), is_success(), is_warning(), kcenon::pacs::services::ups_push_scu::request_cancel(), kcenon::pacs::services::ups_watch_scu::send_watch_action(), and kcenon::pacs::services::ups_push_scu::set().

workitem_uid

std::string kcenon::pacs::services::ups_result::workitem_uid

Workitem SOP Instance UID.

Definition at line 126 of file ups_push_scu.h.

Referenced by kcenon::pacs::services::ups_push_scu::change_state(), kcenon::pacs::services::ups_push_scu::create(), kcenon::pacs::services::ups_push_scu::get(), kcenon::pacs::services::ups_push_scu::request_cancel(), kcenon::pacs::services::ups_watch_scu::send_watch_action(), and kcenon::pacs::services::ups_push_scu::set().

---

The documentation for this struct was generated from the following file:

• include/kcenon/pacs/services/ups/ups_push_scu.h