DailyTrigger

#include <icy/sched/trigger.h>

struct DailyTrigger

Inherits: Trigger

Trigger that fires once per day at a configured time, with optional day-of-week exclusions.

Name	Kind	Owner
`timeOfDay`	`variable`	Declared here
`daysExcluded`	`variable`	Declared here
`DailyTrigger`	`function`	Declared here
`update`	`function`	Declared here
`type`	`variable`	Inherited from `Trigger`
`name`	`variable`	Inherited from `Trigger`
`timesRun`	`variable`	Inherited from `Trigger`
`createdAt`	`variable`	Inherited from `Trigger`
`scheduleAt`	`variable`	Inherited from `Trigger`
`lastRunAt`	`variable`	Inherited from `Trigger`
`Trigger`	`function`	Inherited from `Trigger`
`update`	`function`	Inherited from `Trigger`
`remaining`	`function`	Inherited from `Trigger`
`timeout`	`function`	Inherited from `Trigger`
`expired`	`function`	Inherited from `Trigger`
`serialize`	`function`	Inherited from `Trigger`
`deserialize`	`function`	Inherited from `Trigger`
`~ISerializable`	`function`	Inherited from `ISerializable`
`serialize`	`function`	Inherited from `ISerializable`
`deserialize`	`function`	Inherited from `ISerializable`

Kind	Name	Description
`variable`	`type`	The type of this trigger class.
`variable`	`name`	The display name of this trigger class.
`variable`	`timesRun`	The number of times the task has run since creation;
`variable`	`createdAt`	The time the task was created.
`variable`	`scheduleAt`	The time the task is scheduled to run.
`variable`	`lastRunAt`	The time the task was last run.
`function`	`Trigger`
`function`	`update` `virtual`	Updates the scheduleAt value to the next scheduled time.
`function`	`remaining` `virtual`	Returns the milliseconds remaining until the next scheduled timeout.
`function`	`timeout` `virtual`	Returns true if the task is ready to be run, false otherwise.
`function`	`expired` `virtual`	Returns true if the task is expired and should be destroyed. Returns false by default.
`function`	`serialize` `virtual` `override`	Serializes timing state (type, name, createdAt, scheduleAt, lastRunAt, timesRun) to `root`.
`function`	`deserialize` `virtual` `override`	Deserializes timing state from `root`.

Kind	Name	Description
`function`	`~ISerializable` `virtual`	Defaulted destructor.
`function`	`serialize` `virtual`	Serializes this object's state into `root`.
`function`	`deserialize` `virtual`	Populates this object's state from `root`.

Return	Name	Description
`DateTime`	`timeOfDay`	This value represents the time of day the task will trigger. The date part of the timestamp is redundant.
`std::vector< DaysOfTheWeek >`	`daysExcluded`	Days of the week can be excluded by adding the appropriate bit flag here.

DateTime timeOfDay

This value represents the time of day the task will trigger. The date part of the timestamp is redundant.

std::vector< DaysOfTheWeek > daysExcluded

Days of the week can be excluded by adding the appropriate bit flag here.

Return	Name	Description
	`DailyTrigger`	Constructs the trigger with type "DailyTrigger".
`void`	`update` `virtual` `override`	Computes the next scheduleAt value by advancing to the next non-excluded weekday at the configured timeOfDay.

DailyTrigger()

Constructs the trigger with type "DailyTrigger".

virtual override

virtual void update() override

Computes the next scheduleAt value by advancing to the next non-excluded weekday at the configured timeOfDay.