All mapping keys .from_yaml reads, derived from the serialized properties at compile time so YamlValidator's allowed-key check cannot drift from the class. (A method rather than a constant because instance_vars is only available inside method bodies.)

Absolute begin date/time. Item is never "on" before this date.

Absolute begin date/time. Item is never "on" before this date.

Governs what the Scheduler does with an occurrence that is already running when an absolute (Time) #begin arrives -- e.g. due: hour 8..12 with begin: 10:30. By default the occurrence is dropped: it began before the vdate existed. With this set, it is clamped to start at #begin instead, the same way an occurrence already running at the window's from is clamped to from. Has no effect on a VirtualTime-pattern #begin, which is matched as a pattern rather than used as a boundary.

Governs what the Scheduler does with an occurrence that is already running when an absolute (Time) #begin arrives -- e.g. due: hour 8..12 with begin: 10:30. By default the occurrence is dropped: it began before the vdate existed. With this set, it is clamped to start at #begin instead, the same way an occurrence already running at the window's from is clamped to from. Has no effect on a VirtualTime-pattern #begin, which is matched as a pattern rather than used as a boundary.

Hard deadline — vdate MUST finish before this time or fails scheduling

Hard deadline — vdate MUST finish before this time or fails scheduling

Optional dependencies: scheduler will try to place this vdate after all dependencies. (Used only by Scheduler; VirtualDate itself does not enforce this.)

Optional dependencies: scheduler will try to place this vdate after all dependencies. (Used only by Scheduler; VirtualDate itself does not enforce this.)

Serialized form

Written out by #on_to_yaml, not by the generated serializer; see the note there.

Serialized form

Written out by #on_to_yaml, not by the generated serializer; see the note there.

List of VirtualTimes on which the vdate is "on"/due/active.

List of VirtualTimes on which the vdate is "on"/due/active.

Returns whether any of the vdate's #due rules is on at time.

An empty list means the vdate is always due.

Absolute end date/time. Item is never "on" after this date.

Absolute end date/time. Item is never "on" after this date.

If true, Scheduler treats this vdate as non-movable due to conflicts (still movable by omit-rescheduling rules if you keep shift != false).

If true, Scheduler treats this vdate as non-movable due to conflicts (still movable by omit-rescheduling rules if you keep shift != false).

Flags/categories (e.g. meeting, task, or passive/active/unimportant, or color-coded, or anything). Used by Scheduler for parallelism.

Flags/categories (e.g. meeting, task, or passive/active/unimportant, or color-coded, or anything). Used by Scheduler for parallelism.

Identifier (important for dependencies)

Identifier (important for dependencies)

Returns default if times is empty, true if at least one of them matches time outright, and nil otherwise.

A rule has to match on both its date and its time part. Taking the date from one rule and the time from another would report a match that none of the rules on its own expresses -- and would, for instance, make an #omit of "December 25" together with "12:00" omit every instant of the year, since the first rule constrains no time and the second no date.

Returns default if times is empty, true if at least one of them matches time outright, and nil otherwise.

A rule has to match on both its date and its time part. Taking the date from one rule and the time from another would report a match that none of the rules on its own expresses -- and would, for instance, make an #omit of "December 25" together with "12:00" omit every instant of the year, since the first rule constrains no time and the second no date.

Considers only the date part of each rule.

Returns default if times is empty, true if at least one of them matches time outright, and nil otherwise.

A rule has to match on both its date and its time part. Taking the date from one rule and the time from another would report a match that none of the rules on its own expresses -- and would, for instance, make an #omit of "December 25" together with "12:00" omit every instant of the year, since the first rule constrains no time and the second no date.

Considers only the time part of each rule.

Max amount of total time by which vdate can be shifted before it's considered unschedulable (false)

Max amount of total time by which vdate can be shifted before it's considered unschedulable (false)

Max amount of shift attempts, before it's considered unschedulable (false)

Max amount of shift attempts, before it's considered unschedulable (false)

Returns the start of the earliest occurrence strictly after after, or nil when there is none: the series has ended, #due is empty, or nothing was found within max_candidates occurrences.

An occurrence is a contiguous stretch of due time (see MatchRun): a due time naming only a day is due for the whole of it, and consecutive due days run together into one occurrence. A rule meant to recur once a day therefore names a time of day too (hour: 0), and a day-granular caller asks from the end of the current day to get the next one. An after that falls inside an occurrence is answered with the one following it.

Each occurrence start is settled with #resolve: one that is on as asked is the answer, one that is omitted and shifted counts at the time it shifts to, and one that is omitted without a shift is passed over. A shifted start is only accepted once no later one settles earlier than it.

Only occurrences starting after after are considered. One that started at or before it and shifts past it is not reported, even though #on? answers true for its shifted time: finding it would mean walking back over every occurrence within the total shift bound.

List of VirtualTimes on which the vdate should be "omitted".

List of VirtualTimes on which the vdate should be "omitted".

Returns whether any of the vdate's #omit rules covers time.

An empty list means the vdate is never omitted.

Fixed override of #on? for this vdate. If set, takes precedence over begin/end/due/omit. Same union as #shift.

Written out by #on_to_yaml, not by the generated serializer; see the note there.

Fixed override of #on? for this vdate. If set, takes precedence over begin/end/due/omit. Same union as #shift.

Written out by #on_to_yaml, not by the generated serializer; see the note there.

Checks if the vdate is effectively scheduled at time. Returns:

• true if it is on at time directly, OR due at some base time that resolves (via shifting) to exactly time
• false otherwise (not applicable, not scheduled, or unschedulable)

Unlike #strict_on?, this method never returns nil or Time::Span.

(For omit-driven shifting (Time::Span), we can search candidate base times by shifting back in the opposite direction. This is deterministic, bounded by max_shifts/max_shift.)

Max number of overlapping vdates that share at least one common flag with this vdate. Example: flags={meeting}, parallel=2 means up to 2 meetings can overlap.

Max number of overlapping vdates that share at least one common flag with this vdate. Example: flags={meeting}, parallel=2 means up to 2 meetings can overlap.

Higher wins conflict resolution when Scheduler must choose.

Higher wins conflict resolution when Scheduler must choose.

Resolves the asked VirtualTime to an effective scheduled Time.

Returns:

• Time : resolved scheduled time
• true : scheduled "as asked" (same as returning time, but preserved for symmetry)
• nil : not scheduled
• false : due but unschedulable

Notes:

• For Time input, returned Time preserves the timezone/location of the input time.
• For VirtualTime input, uses hint for materialization as in legacy #on?.

Decision about an vdate to make if it falls on an omitted date/time.

Allowed values are:

• nil: treat the vdate as non-applicable/not-scheduled on the specified date/time
• false: treat the vdate as not due due to falling on an omitted date/time, after a reschedule was not attempted or was not able to find another spot
• true: treat the vdate as due regardless of falling on an omitted date/time
• Time::Span: shift the scheduled date/time by specified time span. Can be negative or positive.

Written out by #on_to_yaml, not by the generated serializer; see the note there.

Decision about an vdate to make if it falls on an omitted date/time.

Allowed values are:

• nil: treat the vdate as non-applicable/not-scheduled on the specified date/time
• false: treat the vdate as not due due to falling on an omitted date/time, after a reschedule was not attempted or was not able to find another spot
• true: treat the vdate as due regardless of falling on an omitted date/time
• Time::Span: shift the scheduled date/time by specified time span. Can be negative or positive.

Written out by #on_to_yaml, not by the generated serializer; see the note there.

Optional staggered parallel scheduling

Optional staggered parallel scheduling

Checks whether the vdate is "on" on the specified date/time.

Return values: nil - vdate is not "on" / not due / not scheduled true - vdate is "on" (due and not omitted) false - vdate is due but omitted and no reschedule requested or possible Time::Span - the span to add to asked date to reach earliest/closest time when vdate is "on"

IMPORTANT: If the vdate is rescheduled away from the asked time, #strict_on? returns a Time::Span, but querying #strict_on? at the rescheduled time will not necessarily return true. Use #resolve or #on? to return a true value for shifted dates/times. ameba:disable Metrics/CyclomaticComplexity

Returns whether time falls within #begin and #end.

A bound that is a VirtualTime is matched as a pattern rather than used as an ordering bound, the way #strict_on? treats it.