kcenon::pacs::services::retrieve_result Struct Reference

Result of a retrieve operation (C-MOVE or C-GET) More...

#include <retrieve_scu.h>

Collaboration diagram for kcenon::pacs::services::retrieve_result:

Public Member Functions
bool	is_success () const noexcept
	Check if the retrieve was fully successful.
bool	is_cancelled () const noexcept
	Check if the retrieve was cancelled.
bool	has_failures () const noexcept
	Check if any sub-operations failed.
bool	has_warnings () const noexcept
	Check if any sub-operations had warnings.

Public Attributes
uint16_t	completed {0}
	Number of successfully completed sub-operations.
uint16_t	failed {0}
	Number of failed sub-operations.
uint16_t	warning {0}
	Number of sub-operations with warnings.
uint16_t	final_status {0}
	Final DIMSE status code.
std::chrono::milliseconds	elapsed {0}
	Retrieve execution time.
std::vector< core::dicom_dataset >	received_instances
	Received instances (for C-GET mode only)

Detailed Description

Result of a retrieve operation (C-MOVE or C-GET)

Contains completion statistics and metadata about the retrieve execution.

Definition at line 121 of file retrieve_scu.h.

Member Function Documentation

has_failures()

bool kcenon::pacs::services::retrieve_result::has_failures ( ) const

inlinenodiscardnoexcept

Check if any sub-operations failed.

Returns

true if at least one sub-operation failed

Definition at line 160 of file retrieve_scu.h.

                                                     {
        return failed > 0;
    }

References failed.

has_warnings()

bool kcenon::pacs::services::retrieve_result::has_warnings ( ) const

inlinenodiscardnoexcept

Check if any sub-operations had warnings.

Returns

true if at least one sub-operation had warnings

Definition at line 168 of file retrieve_scu.h.

                                                     {
        return warning > 0;
    }

References warning.

is_cancelled()

bool kcenon::pacs::services::retrieve_result::is_cancelled ( ) const

inlinenodiscardnoexcept

Check if the retrieve was cancelled.

Returns

true if the operation was cancelled

Definition at line 152 of file retrieve_scu.h.

                                                     {
        return final_status == 0xFE00;
    }

References final_status.

is_success()

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

inlinenodiscardnoexcept

Check if the retrieve was fully successful.

Returns

true if all sub-operations succeeded

Definition at line 144 of file retrieve_scu.h.

                                                   {
        return final_status == 0x0000 && failed == 0;
    }

References failed, and final_status.

Member Data Documentation

completed

uint16_t kcenon::pacs::services::retrieve_result::completed {0}

Number of successfully completed sub-operations.

Definition at line 123 of file retrieve_scu.h.

{0};

Referenced by kcenon::pacs::services::retrieve_scu::perform_get(), and kcenon::pacs::services::retrieve_scu::perform_move().

elapsed

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

Retrieve execution time.

Definition at line 135 of file retrieve_scu.h.

{0};

Referenced by kcenon::pacs::services::retrieve_scu::perform_get(), and kcenon::pacs::services::retrieve_scu::perform_move().

failed

uint16_t kcenon::pacs::services::retrieve_result::failed {0}

Number of failed sub-operations.

Definition at line 126 of file retrieve_scu.h.

{0};

Referenced by has_failures(), is_success(), kcenon::pacs::services::retrieve_scu::perform_get(), and kcenon::pacs::services::retrieve_scu::perform_move().

final_status

uint16_t kcenon::pacs::services::retrieve_result::final_status {0}

Final DIMSE status code.

Definition at line 132 of file retrieve_scu.h.

{0};

Referenced by is_cancelled(), is_success(), kcenon::pacs::services::retrieve_scu::perform_get(), and kcenon::pacs::services::retrieve_scu::perform_move().

received_instances

std::vector<core::dicom_dataset> kcenon::pacs::services::retrieve_result::received_instances

Received instances (for C-GET mode only)

Definition at line 138 of file retrieve_scu.h.

Referenced by kcenon::pacs::services::retrieve_scu::perform_get().

warning

uint16_t kcenon::pacs::services::retrieve_result::warning {0}

Number of sub-operations with warnings.

Definition at line 129 of file retrieve_scu.h.

{0};

Referenced by has_warnings(), kcenon::pacs::services::retrieve_scu::perform_get(), and kcenon::pacs::services::retrieve_scu::perform_move().

---

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

• include/kcenon/pacs/services/retrieve_scu.h