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

#include <series_record.h>

Collaboration diagram for kcenon::pacs::storage::series_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 > study_uid
 Study Instance UID for filtering by study (exact match)
 
std::optional< std::string > series_uid
 Series Instance UID (exact match)
 
std::optional< std::string > modality
 Modality filter (exact match, e.g., "CT", "MR")
 
std::optional< int > series_number
 Series number filter.
 
std::optional< std::string > series_description
 Series description pattern (supports * wildcard)
 
std::optional< std::string > body_part_examined
 Body part examined (exact match)
 
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 90 of file series_record.h.

Member Function Documentation

◆ has_criteria()

auto kcenon::pacs::storage::series_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/series_record.h.

Definition at line 120 of file series_record.h.

120 {
121 return study_uid.has_value() || series_uid.has_value() ||
122 modality.has_value() || series_number.has_value() ||
123 series_description.has_value() || body_part_examined.has_value();
124 }
std::optional< std::string > body_part_examined
Body part examined (exact match)
std::optional< std::string > series_description
Series description pattern (supports * wildcard)
std::optional< std::string > study_uid
Study Instance UID for filtering by study (exact match)
std::optional< std::string > series_uid
Series Instance UID (exact match)
std::optional< int > series_number
Series number filter.
std::optional< std::string > modality
Modality filter (exact match, e.g., "CT", "MR")

References body_part_examined, modality, series_description, series_number, series_uid, and study_uid.

Member Data Documentation

◆ body_part_examined

std::optional<std::string> kcenon::pacs::storage::series_query::body_part_examined

Body part examined (exact match)

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

Definition at line 107 of file series_record.h.

Referenced by has_criteria().

◆ limit

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

Maximum number of results to return (0 = unlimited)

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

Definition at line 110 of file series_record.h.

110{0};

◆ modality

std::optional<std::string> kcenon::pacs::storage::series_query::modality

Modality filter (exact match, e.g., "CT", "MR")

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

Definition at line 98 of file series_record.h.

Referenced by has_criteria().

◆ offset

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

Offset for pagination.

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

Definition at line 113 of file series_record.h.

113{0};

◆ series_description

std::optional<std::string> kcenon::pacs::storage::series_query::series_description

Series description pattern (supports * wildcard)

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

Definition at line 104 of file series_record.h.

Referenced by has_criteria().

◆ series_number

std::optional<int> kcenon::pacs::storage::series_query::series_number

Series number filter.

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

Definition at line 101 of file series_record.h.

Referenced by has_criteria().

◆ series_uid

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

Series Instance UID (exact match)

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

Definition at line 95 of file series_record.h.

Referenced by has_criteria().

◆ study_uid

std::optional<std::string> kcenon::pacs::storage::series_query::study_uid

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