PACS System 0.1.0
PACS DICOM system library
Loading...
Searching...
No Matches
kcenon::pacs::storage::instance_query Struct Reference

#include <instance_record.h>

Collaboration diagram for kcenon::pacs::storage::instance_query:
Collaboration graph

Public Member Functions

auto has_criteria () const noexcept -> bool
 Check if any filter criteria is set.
 

Public Attributes

std::optional< std::string > series_uid
 Series Instance UID for filtering by series (exact match)
 
std::optional< std::string > sop_uid
 SOP Instance UID (exact match)
 
std::optional< std::string > sop_class_uid
 SOP Class UID filter (exact match)
 
std::optional< int > instance_number
 Instance number filter.
 
std::optional< std::string > content_date
 Content date (exact match, format: YYYYMMDD)
 
std::optional< std::string > content_date_from
 Content date range start (inclusive)
 
std::optional< std::string > content_date_to
 Content date range end (inclusive)
 
size_t limit {0}
 Maximum number of results to return (0 = unlimited)
 
size_t offset {0}
 Offset for pagination.
 

Detailed Description

Examples
db_browser/main.cpp, and qr_scp/main.cpp.

Definition at line 105 of file instance_record.h.

Member Function Documentation

◆ has_criteria()

auto kcenon::pacs::storage::instance_query::has_criteria ( ) const -> bool
inlinenodiscardnoexcept

Check if any filter criteria is set.

Returns
true if at least one filter field is set
Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/instance_record.h.

Definition at line 138 of file instance_record.h.

138 {
139 return series_uid.has_value() || sop_uid.has_value() ||
140 sop_class_uid.has_value() || instance_number.has_value() ||
141 content_date.has_value() || content_date_from.has_value() ||
142 content_date_to.has_value();
143 }
std::optional< int > instance_number
Instance number filter.
std::optional< std::string > series_uid
Series Instance UID for filtering by series (exact match)
std::optional< std::string > sop_uid
SOP Instance UID (exact match)
std::optional< std::string > content_date
Content date (exact match, format: YYYYMMDD)
std::optional< std::string > content_date_from
Content date range start (inclusive)
std::optional< std::string > content_date_to
Content date range end (inclusive)
std::optional< std::string > sop_class_uid
SOP Class UID filter (exact match)

References content_date, content_date_from, content_date_to, instance_number, series_uid, sop_class_uid, and sop_uid.

Member Data Documentation

◆ content_date

std::optional<std::string> kcenon::pacs::storage::instance_query::content_date

Content date (exact match, format: YYYYMMDD)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/instance_record.h.

Definition at line 119 of file instance_record.h.

Referenced by has_criteria().

◆ content_date_from

std::optional<std::string> kcenon::pacs::storage::instance_query::content_date_from

Content date range start (inclusive)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/instance_record.h.

Definition at line 122 of file instance_record.h.

Referenced by has_criteria().

◆ content_date_to

std::optional<std::string> kcenon::pacs::storage::instance_query::content_date_to

Content date range end (inclusive)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/instance_record.h.

Definition at line 125 of file instance_record.h.

Referenced by has_criteria().

◆ instance_number

std::optional<int> kcenon::pacs::storage::instance_query::instance_number

Instance number filter.

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/instance_record.h.

Definition at line 116 of file instance_record.h.

Referenced by has_criteria().

◆ limit

size_t kcenon::pacs::storage::instance_query::limit {0}

Maximum number of results to return (0 = unlimited)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/instance_record.h.

Definition at line 128 of file instance_record.h.

128{0};

◆ offset

size_t kcenon::pacs::storage::instance_query::offset {0}

Offset for pagination.

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/instance_record.h.

Definition at line 131 of file instance_record.h.

131{0};

◆ series_uid

std::optional<std::string> kcenon::pacs::storage::instance_query::series_uid

Series Instance UID for filtering by series (exact match)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/instance_record.h, and qr_scp/main.cpp.

Definition at line 107 of file instance_record.h.

Referenced by has_criteria().

◆ sop_class_uid

std::optional<std::string> kcenon::pacs::storage::instance_query::sop_class_uid

SOP Class UID filter (exact match)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/instance_record.h, and qr_scp/main.cpp.

Definition at line 113 of file instance_record.h.

Referenced by has_criteria().

◆ sop_uid

std::optional<std::string> kcenon::pacs::storage::instance_query::sop_uid

SOP Instance UID (exact match)

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/storage/instance_record.h, and qr_scp/main.cpp.

Definition at line 110 of file instance_record.h.

Referenced by has_criteria().


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