kcenon::pacs::workflow::cron_schedule Struct Reference

Cron-like schedule expression. More...

#include <task_scheduler_config.h>

Collaboration diagram for kcenon::pacs::workflow::cron_schedule:

Public Member Functions
auto	to_string () const -> std::string
	Convert to cron expression string.
auto	is_valid () const noexcept -> bool
	Check if the schedule is valid.

Static Public Member Functions
static auto	every_minutes (int n) -> cron_schedule
	Create a schedule that runs every N minutes.
static auto	every_hours (int n) -> cron_schedule
	Create a schedule that runs every N hours.
static auto	daily_at (int hour, int minute=0) -> cron_schedule
	Create a daily schedule at specific time.
static auto	weekly_on (int day_of_week, int hour=0, int minute=0) -> cron_schedule
	Create a weekly schedule.
static auto	parse (const std::string &expr) -> cron_schedule
	Parse a cron expression string.

Public Attributes
std::string	minute {"*"}
	Minute (0-59, or "*")
std::string	hour {"*"}
	Hour (0-23, or "*")
std::string	day_of_month {"*"}
	Day of month (1-31, or "*")
std::string	month {"*"}
	Month (1-12, or "*")
std::string	day_of_week {"*"}
	Day of week (0-6, Sunday=0, or "*")

Detailed Description

Cron-like schedule expression.

Supports cron-style scheduling with minute, hour, day, month, weekday. Special values: * (any), ranges (1-5), lists (1,3,5), steps (*\/5)

Definition at line 54 of file task_scheduler_config.h.

Member Function Documentation

daily_at()

static auto kcenon::pacs::workflow::cron_schedule::daily_at ( int hour, int minute = 0 ) -> cron_schedule

inlinestaticnodiscard

Create a daily schedule at specific time.

Parameters

hour	Hour of day (0-23)
minute	Minute of hour (0-59)

Definition at line 96 of file task_scheduler_config.h.

                                                                                  {
        cron_schedule s;
        s.minute = std::to_string(minute);
        s.hour = std::to_string(hour);
        return s;
    }

References hour, and minute.

every_hours()

static auto kcenon::pacs::workflow::cron_schedule::every_hours ( int n ) -> cron_schedule

inlinestaticnodiscard

Create a schedule that runs every N hours.

Parameters

n	Hours between runs

Definition at line 84 of file task_scheduler_config.h.

                                                                  {
        cron_schedule s;
        s.minute = "0";
        s.hour = "*/" + std::to_string(n);
        return s;
    }

References hour, and minute.

every_minutes()

static auto kcenon::pacs::workflow::cron_schedule::every_minutes ( int n ) -> cron_schedule

inlinestaticnodiscard

Create a schedule that runs every N minutes.

Parameters

n	Minutes between runs

Definition at line 74 of file task_scheduler_config.h.

                                                                    {
        cron_schedule s;
        s.minute = "*/" + std::to_string(n);
        return s;
    }

References minute.

is_valid()

auto kcenon::pacs::workflow::cron_schedule::is_valid ( ) const -> bool

nodiscardnoexcept

Check if the schedule is valid.

Returns

true if all fields are valid

Definition at line 58 of file task_scheduler.cpp.

                                                    {
    // Basic validation - check that fields are not empty
    return !minute.empty() && !hour.empty() && !day_of_month.empty() &&
           !month.empty() && !day_of_week.empty();
}

References day_of_month, day_of_week, hour, minute, and month.

parse()

auto kcenon::pacs::workflow::cron_schedule::parse ( const std::string & expr ) -> cron_schedule

staticnodiscard

Parse a cron expression string.

Parameters

expr	Cron expression (e.g., "0 2 * * *" for daily at 2am)

Returns

Parsed cron_schedule

Definition at line 34 of file task_scheduler.cpp.

                                                                {
    cron_schedule result;
    std::istringstream iss(expr);
    std::vector<std::string> parts;
    std::string part;
 
    while (iss >> part) {
        parts.push_back(part);
    }
 
    if (parts.size() >= 1) result.minute = parts[0];
    if (parts.size() >= 2) result.hour = parts[1];
    if (parts.size() >= 3) result.day_of_month = parts[2];
    if (parts.size() >= 4) result.month = parts[3];
    if (parts.size() >= 5) result.day_of_week = parts[4];
 
    return result;
}

References day_of_month, day_of_week, hour, minute, and month.

to_string()

auto kcenon::pacs::workflow::cron_schedule::to_string ( ) const -> std::string

nodiscard

Convert to cron expression string.

Returns

Cron expression string

Definition at line 53 of file task_scheduler.cpp.

                                                 {
    return minute + " " + hour + " " + day_of_month + " " + month + " " +
           day_of_week;
}

References day_of_month, day_of_week, hour, minute, and month.

weekly_on()

static auto kcenon::pacs::workflow::cron_schedule::weekly_on ( int day_of_week, int hour = 0, int minute = 0 ) -> cron_schedule

inlinestaticnodiscard

Create a weekly schedule.

Parameters

day_of_week	Day of week (0=Sunday, 6=Saturday)
hour	Hour of day
minute	Minute of hour

Definition at line 109 of file task_scheduler_config.h.

                         {
        cron_schedule s;
        s.minute = std::to_string(minute);
        s.hour = std::to_string(hour);
        s.day_of_week = std::to_string(day_of_week);
        return s;
    }

References day_of_week, hour, and minute.

Member Data Documentation

day_of_month

std::string kcenon::pacs::workflow::cron_schedule::day_of_month {"*"}

Day of month (1-31, or "*")

Definition at line 62 of file task_scheduler_config.h.

{"*"};

Referenced by is_valid(), parse(), and to_string().

day_of_week

std::string kcenon::pacs::workflow::cron_schedule::day_of_week {"*"}

Day of week (0-6, Sunday=0, or "*")

Definition at line 68 of file task_scheduler_config.h.

{"*"};

Referenced by is_valid(), parse(), to_string(), and weekly_on().

hour

std::string kcenon::pacs::workflow::cron_schedule::hour {"*"}

Hour (0-23, or "*")

Definition at line 59 of file task_scheduler_config.h.

{"*"};

Referenced by daily_at(), every_hours(), is_valid(), parse(), to_string(), and weekly_on().

minute

std::string kcenon::pacs::workflow::cron_schedule::minute {"*"}

Minute (0-59, or "*")

Definition at line 56 of file task_scheduler_config.h.

{"*"};

Referenced by daily_at(), every_hours(), every_minutes(), is_valid(), parse(), to_string(), and weekly_on().

month

std::string kcenon::pacs::workflow::cron_schedule::month {"*"}

Month (1-12, or "*")

Definition at line 65 of file task_scheduler_config.h.

{"*"};

Referenced by is_valid(), parse(), and to_string().

---

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

• include/kcenon/pacs/workflow/task_scheduler_config.h
• src/workflow/task_scheduler.cpp