kcenon::pacs::web::navigation_info Struct Reference

Navigation info for an instance. More...

#include <metadata_service.h>

Collaboration diagram for kcenon::pacs::web::navigation_info:

Static Public Member Functions
static navigation_info	ok ()
	Create a success result.
static navigation_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.
std::string	previous
	Previous instance UID (empty if first)
std::string	next
	Next instance UID (empty if last)
size_t	index {0}
	Current index (0-based)
size_t	total {0}
	Total instances in series.
std::string	first
	First instance UID.
std::string	last
	Last instance UID.

Detailed Description

Navigation info for an instance.

Definition at line 197 of file metadata_service.h.

Member Function Documentation

error()

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

inlinestatic

Create an error result.

Definition at line 230 of file metadata_service.h.

                                                    {
        navigation_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_navigation().

Here is the caller graph for this function:

ok()

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

inlinestatic

Create a success result.

Definition at line 223 of file metadata_service.h.

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

References success.

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

Here is the caller graph for this function:

Member Data Documentation

error_message

std::string kcenon::pacs::web::navigation_info::error_message

Error message if failed.

Definition at line 202 of file metadata_service.h.

Referenced by error().

first

std::string kcenon::pacs::web::navigation_info::first

First instance UID.

Definition at line 217 of file metadata_service.h.

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

index

size_t kcenon::pacs::web::navigation_info::index {0}

Current index (0-based)

Definition at line 211 of file metadata_service.h.

{0};

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

last

std::string kcenon::pacs::web::navigation_info::last

Last instance UID.

Definition at line 220 of file metadata_service.h.

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

next

std::string kcenon::pacs::web::navigation_info::next

Next instance UID (empty if last)

Definition at line 208 of file metadata_service.h.

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

previous

std::string kcenon::pacs::web::navigation_info::previous

Previous instance UID (empty if first)

Definition at line 205 of file metadata_service.h.

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

success

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

Whether the operation succeeded.

Definition at line 199 of file metadata_service.h.

{false};

Referenced by error(), and ok().

total

size_t kcenon::pacs::web::navigation_info::total {0}

Total instances in series.

Definition at line 214 of file metadata_service.h.

{0};

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

---

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

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