kcenon::pacs::web::frame_info Struct Reference

Multi-frame information. More...

#include <metadata_service.h>

Collaboration diagram for kcenon::pacs::web::frame_info:

Static Public Member Functions
static frame_info	ok ()
	Create a success result.
static frame_info	error (std::string message)
	Create an error result.

Public Attributes
bool	success {false}
	Whether the operation succeeded.
std::string	error_message
	Error message if failed.
uint32_t	total_frames {1}
	Total number of frames.
std::optional< double >	frame_time
	Frame time in milliseconds (for cine)
std::optional< double >	frame_rate
	Frame rate (frames per second)
uint16_t	rows {0}
	Image rows.
uint16_t	columns {0}
	Image columns.

Detailed Description

Multi-frame information.

Definition at line 296 of file metadata_service.h.

Member Function Documentation

error()

static frame_info kcenon::pacs::web::frame_info::error ( std::string message )

inlinestatic

Create an error result.

Definition at line 326 of file metadata_service.h.

                                               {
        frame_info r;
        r.success = false;
        r.error_message = std::move(message);
        return r;
    }

References error_message, and success.

Referenced by kcenon::pacs::web::metadata_service::get_frame_info().

Here is the caller graph for this function:

ok()

static frame_info kcenon::pacs::web::frame_info::ok ( )

inlinestatic

Create a success result.

Definition at line 319 of file metadata_service.h.

                           {
        frame_info r;
        r.success = true;
        return r;
    }

References success.

Referenced by kcenon::pacs::web::metadata_service::get_frame_info().

Here is the caller graph for this function:

Member Data Documentation

columns

uint16_t kcenon::pacs::web::frame_info::columns {0}

Image columns.

Definition at line 316 of file metadata_service.h.

{0};

error_message

std::string kcenon::pacs::web::frame_info::error_message

Error message if failed.

Definition at line 301 of file metadata_service.h.

Referenced by error().

frame_rate

std::optional<double> kcenon::pacs::web::frame_info::frame_rate

Frame rate (frames per second)

Definition at line 310 of file metadata_service.h.

frame_time

std::optional<double> kcenon::pacs::web::frame_info::frame_time

Frame time in milliseconds (for cine)

Definition at line 307 of file metadata_service.h.

rows

uint16_t kcenon::pacs::web::frame_info::rows {0}

Image rows.

Definition at line 313 of file metadata_service.h.

{0};

success

bool kcenon::pacs::web::frame_info::success {false}

Whether the operation succeeded.

Definition at line 298 of file metadata_service.h.

{false};

Referenced by error(), and ok().

total_frames

uint32_t kcenon::pacs::web::frame_info::total_frames {1}

Total number of frames.

Definition at line 304 of file metadata_service.h.

{1};

---

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

• include/kcenon/pacs/web/metadata_service.h