#include <query_builder.h>

Collaboration diagram for query_scu::query_builder:

Public Types
using	query_level = kcenon::pacs::services::query_level

Public Member Functions
	query_builder ()=default

query_builder &	level (query_level lvl)
	Set the query/retrieve level.

query_builder &	patient_name (std::string_view name)
	Set patient name search criteria (supports wildcards)

query_builder &	patient_id (std::string_view id)
	Set patient ID search criteria.

query_builder &	patient_birth_date (std::string_view date)
	Set patient birth date criteria.

query_builder &	patient_sex (std::string_view sex)
	Set patient sex criteria.

query_builder &	study_date (std::string_view date)
	Set study date criteria (supports ranges)

query_builder &	study_time (std::string_view time)
	Set study time criteria.

query_builder &	accession_number (std::string_view accession)
	Set accession number criteria.

query_builder &	study_instance_uid (std::string_view uid)
	Set study instance UID criteria.

query_builder &	study_id (std::string_view id)
	Set study ID criteria.

query_builder &	study_description (std::string_view desc)
	Set study description criteria.

query_builder &	modality (std::string_view mod)
	Set modality criteria.

query_builder &	series_instance_uid (std::string_view uid)
	Set series instance UID criteria.

query_builder &	series_number (std::string_view num)
	Set series number criteria.

query_builder &	series_description (std::string_view desc)
	Set series description criteria.

query_builder &	sop_instance_uid (std::string_view uid)
	Set SOP instance UID criteria.

query_builder &	instance_number (std::string_view num)
	Set instance number criteria.

kcenon::pacs::core::dicom_dataset	build () const
	Build the query dataset.

Private Member Functions
void	add_patient_keys (kcenon::pacs::core::dicom_dataset &ds) const

void	add_study_keys (kcenon::pacs::core::dicom_dataset &ds) const

void	add_series_keys (kcenon::pacs::core::dicom_dataset &ds) const

void	add_instance_keys (kcenon::pacs::core::dicom_dataset &ds) const

Private Attributes
query_level	level_ {query_level::study}

std::string	patient_name_

std::string	patient_id_

std::string	patient_birth_date_

std::string	patient_sex_

std::string	study_date_

std::string	study_time_

std::string	accession_number_

std::string	study_instance_uid_

std::string	study_id_

std::string	study_description_

std::string	modality_

std::string	series_instance_uid_

std::string	series_number_

std::string	series_description_

std::string	sop_instance_uid_

std::string	instance_number_

Detailed Description

Examples: query_scu/main.cpp.

Definition at line 42 of file query_builder.h.

Member Typedef Documentation

◆ query_level

using query_scu::query_builder::query_level = kcenon::pacs::services::query_level

Definition at line 44 of file query_builder.h.

Constructor & Destructor Documentation

◆ query_builder()

query_scu::query_builder::query_builder ( )

default

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Member Function Documentation

◆ accession_number()

query_builder & query_scu::query_builder::accession_number ( std::string_view accession )

inline

Set accession number criteria.

Parameters

accession Accession number pattern

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 124 of file query_builder.h.

                                                              {
        accession_number_ = accession;
        return *this;
    }

References accession_number_.

◆ add_instance_keys()

void query_scu::query_builder::add_instance_keys ( kcenon::pacs::core::dicom_dataset & ds ) const

inlineprivate

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 354 of file query_builder.h.

                                                                  {
        using namespace kcenon::pacs::core;
        using namespace kcenon::pacs::encoding;
 
        // SOP Instance UID - required for Instance level
        ds.set_string(tags::sop_instance_uid, vr_type::UI, sop_instance_uid_);
 
        // SOP Class UID (return key)
        ds.set_string(tags::sop_class_uid, vr_type::UI, "");
 
        // Instance Number
        if (!instance_number_.empty()) {
            ds.set_string(tags::instance_number, vr_type::IS, instance_number_);
        } else {
            ds.set_string(tags::instance_number, vr_type::IS, "");
        }
    }

References instance_number_, kcenon::pacs::core::dicom_dataset::set_string(), and sop_instance_uid_.

Referenced by build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add_patient_keys()

void query_scu::query_builder::add_patient_keys ( kcenon::pacs::core::dicom_dataset & ds ) const

inlineprivate

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 262 of file query_builder.h.

                                                                 {
        using namespace kcenon::pacs::core;
        using namespace kcenon::pacs::encoding;
 
        // Patient Name - always include as return key
        ds.set_string(tags::patient_name, vr_type::PN, patient_name_);
 
        // Patient ID
        ds.set_string(tags::patient_id, vr_type::LO, patient_id_);
 
        // Patient Birth Date
        if (!patient_birth_date_.empty()) {
            ds.set_string(tags::patient_birth_date, vr_type::DA, patient_birth_date_);
        } else {
            ds.set_string(tags::patient_birth_date, vr_type::DA, "");
        }
 
        // Patient Sex
        if (!patient_sex_.empty()) {
            ds.set_string(tags::patient_sex, vr_type::CS, patient_sex_);
        } else {
            ds.set_string(tags::patient_sex, vr_type::CS, "");
        }
    }

References patient_birth_date_, patient_id_, patient_name_, patient_sex_, and kcenon::pacs::core::dicom_dataset::set_string().

Referenced by build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add_series_keys()

void query_scu::query_builder::add_series_keys ( kcenon::pacs::core::dicom_dataset & ds ) const

inlineprivate

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 330 of file query_builder.h.

                                                                {
        using namespace kcenon::pacs::core;
        using namespace kcenon::pacs::encoding;
 
        // Series Instance UID - required for Series level
        ds.set_string(tags::series_instance_uid, vr_type::UI, series_instance_uid_);
 
        // Modality
        ds.set_string(tags::modality, vr_type::CS, modality_);
 
        // Series Number
        if (!series_number_.empty()) {
            ds.set_string(tags::series_number, vr_type::IS, series_number_);
        } else {
            ds.set_string(tags::series_number, vr_type::IS, "");
        }
 
        // Series Description
        ds.set_string(tags::series_description, vr_type::LO, series_description_);
 
        // Number of Series Related Instances (return key)
        ds.set_string(tags::number_of_series_related_instances, vr_type::IS, "");
    }

References modality_, series_description_, series_instance_uid_, series_number_, and kcenon::pacs::core::dicom_dataset::set_string().

Referenced by build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add_study_keys()

void query_scu::query_builder::add_study_keys ( kcenon::pacs::core::dicom_dataset & ds ) const

inlineprivate

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 287 of file query_builder.h.

                                                               {
        using namespace kcenon::pacs::core;
        using namespace kcenon::pacs::encoding;
 
        // Study Instance UID - required for Study level
        ds.set_string(tags::study_instance_uid, vr_type::UI, study_instance_uid_);
 
        // Study Date
        ds.set_string(tags::study_date, vr_type::DA, study_date_);
 
        // Study Time
        if (!study_time_.empty()) {
            ds.set_string(tags::study_time, vr_type::TM, study_time_);
        } else {
            ds.set_string(tags::study_time, vr_type::TM, "");
        }
 
        // Accession Number
        ds.set_string(tags::accession_number, vr_type::SH, accession_number_);
 
        // Study ID
        if (!study_id_.empty()) {
            ds.set_string(tags::study_id, vr_type::SH, study_id_);
        } else {
            ds.set_string(tags::study_id, vr_type::SH, "");
        }
 
        // Study Description
        ds.set_string(tags::study_description, vr_type::LO, study_description_);
 
        // Referring Physician's Name (return key)
        ds.set_string(tags::referring_physician_name, vr_type::PN, "");
 
        // Number of Study Related Series (return key)
        ds.set_string(tags::number_of_study_related_series, vr_type::IS, "");
 
        // Number of Study Related Instances (return key)
        ds.set_string(tags::number_of_study_related_instances, vr_type::IS, "");
 
        // Modalities in Study (return key)
        ds.set_string(tags::modalities_in_study, vr_type::CS, modality_);
    }

References accession_number_, modality_, kcenon::pacs::core::dicom_dataset::set_string(), study_date_, study_description_, study_id_, study_instance_uid_, and study_time_.

Referenced by build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ build()

kcenon::pacs::core::dicom_dataset query_scu::query_builder::build ( ) const

inlinenodiscard

Build the query dataset.

Returns: Configured DICOM dataset ready for C-FIND

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 226 of file query_builder.h.

                                                            {
        using namespace kcenon::pacs::core;
        using namespace kcenon::pacs::encoding;
 
        dicom_dataset ds;
 
        // Set Query/Retrieve Level (required)
        ds.set_string(tags::query_retrieve_level, vr_type::CS,
                      std::string(kcenon::pacs::services::to_string(level_)));
 
        // Add return keys and search criteria based on level
        switch (level_) {
            case query_level::patient:
                add_patient_keys(ds);
                break;
            case query_level::study:
                add_patient_keys(ds);
                add_study_keys(ds);
                break;
            case query_level::series:
                add_patient_keys(ds);
                add_study_keys(ds);
                add_series_keys(ds);
                break;
            case query_level::image:
                add_patient_keys(ds);
                add_study_keys(ds);
                add_series_keys(ds);
                add_instance_keys(ds);
                break;
        }
 
        return ds;
    }

References add_instance_keys(), add_patient_keys(), add_series_keys(), add_study_keys(), level_, and kcenon::pacs::services::to_string().

Here is the call graph for this function:

◆ instance_number()

query_builder & query_scu::query_builder::instance_number ( std::string_view num )

inline

Set instance number criteria.

Parameters

num	Instance number

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 213 of file query_builder.h.

                                                       {
        instance_number_ = num;
        return *this;
    }

References instance_number_.

◆ level()

query_builder & query_scu::query_builder::level ( query_level lvl )

inline

Set the query/retrieve level.

Parameters

lvl	The query level (PATIENT, STUDY, SERIES, IMAGE)

Returns: Reference to this builder for chaining

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 53 of file query_builder.h.

                                          {
        level_ = lvl;
        return *this;
    }

References level_.

◆ modality()

query_builder & query_scu::query_builder::modality ( std::string_view mod )

inline

Set modality criteria.

Parameters

mod	Modality code (CT, MR, US, XR, etc.)

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 164 of file query_builder.h.

                                                {
        modality_ = mod;
        return *this;
    }

References modality_.

◆ patient_birth_date()

query_builder & query_scu::query_builder::patient_birth_date ( std::string_view date )

inline

Set patient birth date criteria.

Parameters

date	Birth date in DICOM DA format (YYYYMMDD or range)

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 84 of file query_builder.h.

                                                           {
        patient_birth_date_ = date;
        return *this;
    }

References patient_birth_date_.

◆ patient_id()

query_builder & query_scu::query_builder::patient_id ( std::string_view id )

inline

Set patient ID search criteria.

Parameters

id	Patient ID pattern

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 75 of file query_builder.h.

                                                 {
        patient_id_ = id;
        return *this;
    }

References patient_id_.

◆ patient_name()

query_builder & query_scu::query_builder::patient_name ( std::string_view name )

inline

Set patient name search criteria (supports wildcards)

Parameters

name	Patient name pattern (e.g., "DOE^JOHN" or "DOE^*")

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 66 of file query_builder.h.

                                                     {
        patient_name_ = name;
        return *this;
    }

References name, and patient_name_.

◆ patient_sex()

query_builder & query_scu::query_builder::patient_sex ( std::string_view sex )

inline

Set patient sex criteria.

Parameters

sex	Patient sex (M, F, O)

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 93 of file query_builder.h.

                                                   {
        patient_sex_ = sex;
        return *this;
    }

References patient_sex_.

◆ series_description()

query_builder & query_scu::query_builder::series_description ( std::string_view desc )

inline

Set series description criteria.

Parameters

desc	Series description pattern

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 191 of file query_builder.h.

                                                           {
        series_description_ = desc;
        return *this;
    }

References series_description_.

◆ series_instance_uid()

query_builder & query_scu::query_builder::series_instance_uid ( std::string_view uid )

inline

Set series instance UID criteria.

Parameters

uid	Series Instance UID

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 173 of file query_builder.h.

                                                           {
        series_instance_uid_ = uid;
        return *this;
    }

References series_instance_uid_, and uid.

◆ series_number()

query_builder & query_scu::query_builder::series_number ( std::string_view num )

inline

Set series number criteria.

Parameters

num	Series number

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 182 of file query_builder.h.

                                                     {
        series_number_ = num;
        return *this;
    }

References series_number_.

◆ sop_instance_uid()

query_builder & query_scu::query_builder::sop_instance_uid ( std::string_view uid )

inline

Set SOP instance UID criteria.

Parameters

uid	SOP Instance UID

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 204 of file query_builder.h.

                                                        {
        sop_instance_uid_ = uid;
        return *this;
    }

References sop_instance_uid_, and uid.

◆ study_date()

query_builder & query_scu::query_builder::study_date ( std::string_view date )

inline

Set study date criteria (supports ranges)

Parameters

date	Study date in DICOM DA format (YYYYMMDD, YYYYMMDD-YYYYMMDD)

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 106 of file query_builder.h.

                                                   {
        study_date_ = date;
        return *this;
    }

References study_date_.

◆ study_description()

query_builder & query_scu::query_builder::study_description ( std::string_view desc )

inline

Set study description criteria.

Parameters

desc	Study description pattern

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 151 of file query_builder.h.

                                                          {
        study_description_ = desc;
        return *this;
    }

References study_description_.

◆ study_id()

query_builder & query_scu::query_builder::study_id ( std::string_view id )

inline

Set study ID criteria.

Parameters

id	Study ID pattern

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 142 of file query_builder.h.

                                               {
        study_id_ = id;
        return *this;
    }

References study_id_.

◆ study_instance_uid()

query_builder & query_scu::query_builder::study_instance_uid ( std::string_view uid )

inline

Set study instance UID criteria.

Parameters

uid	Study Instance UID

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 133 of file query_builder.h.

                                                          {
        study_instance_uid_ = uid;
        return *this;
    }

References study_instance_uid_, and uid.

◆ study_time()

query_builder & query_scu::query_builder::study_time ( std::string_view time )

inline

Set study time criteria.

Parameters

time	Study time in DICOM TM format

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h, and query_scu/main.cpp.

Definition at line 115 of file query_builder.h.

                                                   {
        study_time_ = time;
        return *this;
    }

References study_time_.

Member Data Documentation

◆ accession_number_

std::string query_scu::query_builder::accession_number_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 384 of file query_builder.h.

Referenced by accession_number(), and add_study_keys().

◆ instance_number_

std::string query_scu::query_builder::instance_number_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 397 of file query_builder.h.

Referenced by add_instance_keys(), and instance_number().

◆ level_

query_level query_scu::query_builder::level_ {query_level::study}

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 373 of file query_builder.h.

373{query_level::study};

Referenced by build(), and level().

◆ modality_

std::string query_scu::query_builder::modality_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 390 of file query_builder.h.

Referenced by add_series_keys(), add_study_keys(), and modality().

◆ patient_birth_date_

std::string query_scu::query_builder::patient_birth_date_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 378 of file query_builder.h.

Referenced by add_patient_keys(), and patient_birth_date().

◆ patient_id_

std::string query_scu::query_builder::patient_id_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 377 of file query_builder.h.

Referenced by add_patient_keys(), and patient_id().

◆ patient_name_

std::string query_scu::query_builder::patient_name_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 376 of file query_builder.h.

Referenced by add_patient_keys(), and patient_name().

◆ patient_sex_

std::string query_scu::query_builder::patient_sex_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 379 of file query_builder.h.

Referenced by add_patient_keys(), and patient_sex().

◆ series_description_

std::string query_scu::query_builder::series_description_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 393 of file query_builder.h.

Referenced by add_series_keys(), and series_description().

◆ series_instance_uid_

std::string query_scu::query_builder::series_instance_uid_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 391 of file query_builder.h.

Referenced by add_series_keys(), and series_instance_uid().

◆ series_number_

std::string query_scu::query_builder::series_number_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 392 of file query_builder.h.

Referenced by add_series_keys(), and series_number().

◆ sop_instance_uid_

std::string query_scu::query_builder::sop_instance_uid_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 396 of file query_builder.h.

Referenced by add_instance_keys(), and sop_instance_uid().

◆ study_date_

std::string query_scu::query_builder::study_date_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 382 of file query_builder.h.

Referenced by add_study_keys(), and study_date().

◆ study_description_

std::string query_scu::query_builder::study_description_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 387 of file query_builder.h.

Referenced by add_study_keys(), and study_description().

◆ study_id_

std::string query_scu::query_builder::study_id_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 386 of file query_builder.h.

Referenced by add_study_keys(), and study_id().

◆ study_instance_uid_

std::string query_scu::query_builder::study_instance_uid_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 385 of file query_builder.h.

Referenced by add_study_keys(), and study_instance_uid().

◆ study_time_

std::string query_scu::query_builder::study_time_

private

Examples: /home/runner/work/pacs_system/pacs_system/examples/query_scu/query_builder.h.

Definition at line 383 of file query_builder.h.

Referenced by add_study_keys(), and study_time().

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

examples/query_scu/query_builder.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ query_level

Constructor & Destructor Documentation

◆ query_builder()

Member Function Documentation

◆ accession_number()

◆ add_instance_keys()

◆ add_patient_keys()

◆ add_series_keys()

◆ add_study_keys()

◆ build()

◆ instance_number()

◆ level()

◆ modality()

◆ patient_birth_date()

◆ patient_id()

◆ patient_name()

◆ patient_sex()

◆ series_description()

◆ series_instance_uid()

◆ series_number()

◆ sop_instance_uid()

◆ study_date()

◆ study_description()

◆ study_id()

◆ study_instance_uid()

◆ study_time()

Member Data Documentation

◆ accession_number_

◆ instance_number_

◆ level_

◆ modality_

◆ patient_birth_date_

◆ patient_id_

◆ patient_name_

◆ patient_sex_

◆ series_description_

◆ series_instance_uid_

◆ series_number_

◆ sop_instance_uid_

◆ study_date_

◆ study_description_

◆ study_id_

◆ study_instance_uid_

◆ study_time_