Building the schedule

The whole schedule consists of multiple independent 'sub' schedules, each addressing different attributes of holidays.

We need 3 Halt schedules, plus 1 Restart schedule as follows.

Regular Annual holidays

Martin Luther King, Jr. Day occurs on the 3rd Monday in January.
George Washington’s Birthday occurs on the 3rd Monday in February.
Memorial Day occurs on the 5th Monday in February.
Labor Day occurs on the 1st Monday in September.
Columbus Day occurs on the 2nd Monday in October.
Thanksgiving Day occurs on the 4th Thursday in November.

These are the 6 holidays, which can be repeated every year.

XML fragment

<fds:schedules xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:fds="http://xml.firedaemon.com/scheduling/v3" xmlns:fd="http://xml.firedaemon.com">
    <schedule name="US Federal Holidays, Annual, Regular" fd:fixed_duration_as="downtime">
        <interval xsi:type="fds:attributive_interval" granularity="year_interval" length="1" blueprint="fixed_subrange_duration">

            <onset name="Martin Luther King, Jr. Day"
                   minute="0" hour="4" month="0" weekday="0" first_dow="0" nth_kday_of_month="3"/>
            <onset minute="0" hour="4" month="0" weekday="0" first_dow="0" nth_kday_of_month="3"/>

            <onset name="George Washington’s Birthday"
                   minute="0" hour="4" month="1" weekday="0" first_dow="0" nth_kday_of_month="3"/>
            <onset minute="0" hour="4" month="1" weekday="0" first_dow="0" nth_kday_of_month="3"/>

            <onset name="Memorial Day"
                   minute="0" hour="4" month="1" weekday="0" first_dow="0" nth_kday_of_month="5"/>
            <onset minute="0" hour="4" month="1" weekday="0" first_dow="0" nth_kday_of_month="5"/>

            <onset name="Labor Day"
                   minute="0" hour="4" month="8" weekday="0" first_dow="0" nth_kday_of_month="1"/>
            <onset minute="0" hour="4" month="8" weekday="0" first_dow="0" nth_kday_of_month="1"/>

            <onset name="Columbus Day"
                   minute="0" hour="4" month="9" weekday="0" first_dow="0" nth_kday_of_month="2"/>
            <onset minute="0" hour="4" month="9" weekday="0" first_dow="0" nth_kday_of_month="2"/>

            <onset name="Thanksgiving Day"
                   minute="0" hour="4" month="10" weekday="3" first_dow="0" nth_kday_of_month="4"/>
            <onset minute="0" hour="4" month="10" weekday="3" first_dow="0" nth_kday_of_month="4"/>
        </interval>
    </schedule>
</fds:schedules>

US Federal Holidays, Annual, Regular.xml

C++ fragment

using fixed_duration_as = timepiece_settings::fixed_duration_as;

interval_schedule_data sd1{year_interval, L"US Federal Holidays, Annual, Regular"};
sd1.blueprint = onset_series_blueprint::fixed_subrange_duration;
// 6 onset/completion pairs
sd1.cycle.resize(6 * 2);
sd1.cycle[0] = {0, 0, 4, 0, 0, 0, Monday, iso_sunday, 3};     // Martin Luther King, Jr. Day
sd1.cycle[1] = {0, 0, 4, 0, 0, 0, Monday, iso_sunday, 3};     //
sd1.cycle[2] = {0, 0, 4, 0, 1, 0, Monday, iso_sunday, 3};     // George Washington’s Birthday
sd1.cycle[3] = {0, 0, 4, 0, 1, 0, Monday, iso_sunday, 3};     //
sd1.cycle[4] = {0, 0, 4, 0, 4, 0, Monday, iso_sunday, 5};     // Memorial Day
sd1.cycle[5] = {0, 0, 4, 0, 4, 0, Monday, iso_sunday, 5};     //
sd1.cycle[6] = {0, 0, 4, 0, 8, 0, Monday, iso_sunday, 1};     // Labor Day
sd1.cycle[7] = {0, 0, 4, 0, 8, 0, Monday, iso_sunday, 1};     //
sd1.cycle[8] = {0, 0, 4, 0, 9, 0, Monday, iso_sunday, 2};     // Columbus Day
sd1.cycle[9] = {0, 0, 4, 0, 9, 0, Monday, iso_sunday, 2};     //
sd1.cycle[10] = {0, 0, 4, 0, 10, 0, Thursday, iso_sunday, 4}; // Thanksgiving Day
sd1.cycle[11] = {0, 0, 4, 0, 10, 0, Thursday, iso_sunday, 4}; //

Annual holidays on fixed dates

New Year's Day occurs on the 1st of January.
Juneteenth occurs on the 19th of June.
Independence Day occurs on the 4th of July.
Veterans Day occurs on the 11th of November.
Christmas Day occurs on the 25th of December.

When a federal holiday falls on a Saturday, it is usually observed on the preceding Friday. When the holiday falls on a Sunday, it is usually observed on the following Monday.

Due to this rule, those days are observed potentially on different dates each year. synkronize's timepoint generator has to be made aware of this special rule.

XML fragment

<schedule name="US Federal Holidays, Annual, Fixed Date" fd:fixed_duration_as="downtime" fd:calendar_date_adjustment_rule="us_federal_holiday_observance">
    <interval xsi:type="fds:attributive_interval" granularity="year_interval" length="1" blueprint="fixed_subrange_duration">

        <onset name="New Year's Day"
               minute="0" hour="4" monthday="0" month="0"/>
        <onset minute="0" hour="4" monthday="0" month="0"/>

        <onset name="Juneteenth"
               minute="0" hour="4" monthday="18" month="5"/>
        <onset minute="0" hour="4" monthday="18" month="5"/>

        <onset name="Independence Day"
               minute="0" hour="4" monthday="3" month="6"/>
        <onset minute="0" hour="4" monthday="3" month="6"/>

        <onset name="Veterans Day"
               minute="0" hour="4" monthday="10" month="10"/>
        <onset minute="0" hour="4" monthday="10" month="10"/>

        <onset name="Christmas Day"
               minute="0" hour="4" monthday="24" month="11"/>
        <onset minute="0" hour="4" monthday="24" month="11"/>
    </interval>
</schedule>

US Federal Holidays, Annual, Fixed Dates.xml

C++ fragment

using fixed_duration_as = timepiece_settings::fixed_duration_as;

interval_schedule_data sd2{year_interval, L"US Federal Holidays, Annual, Fixed Dates"};
sd2.blueprint = onset_series_blueprint::fixed_subrange_duration;
// 5 onset/completion pairs
sd2.cycle.resize(5 * 2);
sd2.cycle[0] = {0, 0, 4, 0, 0, 0};   // New Year's Day
sd2.cycle[1] = {0, 0, 4, 0, 0, 0};   //
sd2.cycle[1] = {0, 0, 4, 18, 5, 0};  // Juneteenth
sd2.cycle[2] = {0, 0, 4, 18, 5, 0};  //
sd2.cycle[3] = {0, 0, 4, 3, 6, 0};   // Independence Day
sd2.cycle[4] = {0, 0, 4, 3, 6, 0};   //
sd2.cycle[5] = {0, 0, 4, 10, 10, 0}; // Veterans Day
sd2.cycle[6] = {0, 0, 4, 10, 10, 0}; //
sd2.cycle[7] = {0, 0, 4, 24, 11, 0}; // Christmas Day
sd2.cycle[8] = {0, 0, 4, 24, 11, 0}; //

Inauguration Day

This holiday repeats every 4 years following a U.S. presidential election. Hence it is necessary to fix the schedule's start period at a certain year.

Additionally, a similar rule like for a federal holiday falling on a weekend applies: if it falls on a Sunday it is usually observed on the following Monday.

	Note
	The requirement to repeat the holiday "every 4 years" is represented with `length="4"` in XML, and with `fd::interval_schedule_data::factor=4` in C++.

XML fragment

<fds:schedules xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:fds="http://xml.firedaemon.com/scheduling/v3" xmlns:fd="http://xml.firedaemon.com">
    <schedule name="US Inauguration Day" fd:fixed_duration_as="downtime" fd:calendar_date_adjustment_rule="us_inauguration_day_observance">
        <activity_boundary from="2021-01-01T00:00:00"/>
        <interval xsi:type="fds:attributive_interval" granularity="year_interval" length="4" blueprint="fixed_subrange_duration">

            <onset name="Inauguration Day"
                   minute="0" hour="4" monthday="19" month="0"/>
            <onset minute="0" hour="4" monthday="19" month="0"/>
        </interval>
    </schedule>
</fds:schedules>

US Inauguration Day.xml

C++ fragment

interval_schedule_data sd3{year_interval, L"US Inauguration Day"};
sd3.blueprint = onset_series_blueprint::fixed_subrange_duration;
// must fix the schedule at its beginning because it repeats every 4 years
sd3.active_from = {date(2021, 1, 1), time_duration(0, 0, 0)};
sd3.interval.factor = 4;
// 1 onset/completion pair
sd3.cycle.resize(1 * 2);
sd3.cycle[0] = {0, 0, 4, 19, 0, 0}; // Inauguration Day
sd3.cycle[1] = {0, 0, 4, 19, 0, 0}; //

Restart schedule

It may be useful to restart the program running as a service on a daily basis. This schedule restarts the program daily at 4AM.

When you want to restart the program periodically, a single Restart schedule is sufficient - Restarts only occur within uptime (reversely they are ignored during downtime).

XML fragment

<fds:schedules xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:fds="http://xml.firedaemon.com/scheduling/v3" xmlns:fd="http://xml.firedaemon.com">
    <schedule name="Restart daily at 4AM">
        <interval xsi:type="fds:attributive_interval" granularity="day_interval" length="1" blueprint="evenly_clocked">
            <onset minute="0" hour="4"/>
        </interval>
    </schedule>
</fds:schedules>

Restart.xml

C++ fragment

interval_schedule_data sd4{day_interval, L"Restart daily at 4AM"};
sd4.blueprint = onset_series_blueprint::evenly_clocked;
// A single onset
sd4.cycle.resize(1 * 1);
sd4.cycle[0] = {0, 0, 4};