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

Progress tracking for a job. More...

#include <job_types.h>

Collaboration diagram for kcenon::pacs::client::job_progress:
Collaboration graph

Public Member Functions

void calculate_percent () noexcept
 Calculate completion percentage from item counts.
 
bool is_complete () const noexcept
 Check if all items have been processed.
 

Public Attributes

size_t total_items {0}
 Total number of items to process.
 
size_t completed_items {0}
 Successfully completed items.
 
size_t failed_items {0}
 Failed items.
 
size_t skipped_items {0}
 Skipped items.
 
size_t bytes_transferred {0}
 Total bytes transferred.
 
float percent_complete {0.0f}
 Completion percentage (0-100)
 
std::string current_item
 Current SOP Instance UID being processed.
 
std::string current_item_description
 Human-readable description.
 
std::chrono::milliseconds elapsed {0}
 Time elapsed since start.
 
std::chrono::milliseconds estimated_remaining {0}
 Estimated time remaining.
 

Detailed Description

Progress tracking for a job.

Contains detailed progress information for monitoring job execution.

Definition at line 211 of file job_types.h.

Member Function Documentation

◆ calculate_percent()

void kcenon::pacs::client::job_progress::calculate_percent ( )
inlinenoexcept

Calculate completion percentage from item counts.

Definition at line 229 of file job_types.h.

229 {
230 if (total_items > 0) {
232 / static_cast<float>(total_items) * 100.0f;
233 }
234 }
size_t failed_items
Failed items.
Definition job_types.h:214
size_t skipped_items
Skipped items.
Definition job_types.h:215
size_t completed_items
Successfully completed items.
Definition job_types.h:213
size_t total_items
Total number of items to process.
Definition job_types.h:212
float percent_complete
Completion percentage (0-100)
Definition job_types.h:218

References completed_items, failed_items, percent_complete, skipped_items, and total_items.

Referenced by kcenon::pacs::client::job_manager::impl::execute_store_job().

Here is the caller graph for this function:

◆ is_complete()

bool kcenon::pacs::client::job_progress::is_complete ( ) const
inlinenodiscardnoexcept

Check if all items have been processed.

Definition at line 239 of file job_types.h.

239 {
240 return total_items > 0 &&
242 }

References completed_items, failed_items, skipped_items, and total_items.

Member Data Documentation

◆ bytes_transferred

size_t kcenon::pacs::client::job_progress::bytes_transferred {0}

Total bytes transferred.

Definition at line 216 of file job_types.h.

216{0};

◆ completed_items

◆ current_item

std::string kcenon::pacs::client::job_progress::current_item

Current SOP Instance UID being processed.

Definition at line 220 of file job_types.h.

Referenced by kcenon::pacs::client::job_manager::impl::execute_store_job().

◆ current_item_description

◆ elapsed

std::chrono::milliseconds kcenon::pacs::client::job_progress::elapsed {0}

Time elapsed since start.

Definition at line 223 of file job_types.h.

223{0};

Referenced by kcenon::pacs::client::job_manager::impl::execute_retrieve_job().

◆ estimated_remaining

std::chrono::milliseconds kcenon::pacs::client::job_progress::estimated_remaining {0}

Estimated time remaining.

Definition at line 224 of file job_types.h.

224{0};

◆ failed_items

size_t kcenon::pacs::client::job_progress::failed_items {0}

◆ percent_complete

◆ skipped_items

size_t kcenon::pacs::client::job_progress::skipped_items {0}

Skipped items.

Definition at line 215 of file job_types.h.

215{0};

Referenced by calculate_percent(), kcenon::pacs::client::job_manager::impl::execute_retrieve_job(), and is_complete().

◆ total_items


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