class VirtualDate

• VirtualDate
• Reference
• Object

Overview

VirtualDate builds on VirtualTime to represent due/omit rules plus higher-level scheduling semantics.

Included Modules

• YAML::Serializable

Defined in:

virtualdate.cr

Constant Summary

VERSION = [VERSION_MAJOR, VERSION_MINOR, VERSION_REVISION].join('.')

VERSION_MAJOR = 1

VERSION_MINOR = 2

VERSION_REVISION = 1

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(id : String | Nil = "")

Instance Method Summary

• #begin : VirtualTime::TimeOrVirtualTime | Nil

  Absolute begin date/time.

• #begin=(begin __arg0 : VirtualTime::TimeOrVirtualTime | Nil)

  Absolute begin date/time.

• #deadline : VirtualTime::TimeOrVirtualTime | Nil

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

• #deadline=(deadline : VirtualTime::TimeOrVirtualTime | Nil)

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

• #depends_on : Array(VirtualDate)

  Optional dependencies: scheduler will try to place this vdate after all dependencies.

• #depends_on=(depends_on : Array(VirtualDate))

  Optional dependencies: scheduler will try to place this vdate after all dependencies.

• #depends_on_ids : Array(String)

  Serialized form

• #depends_on_ids=(depends_on_ids : Array(String))

  Serialized form

• #due : Array(VirtualTime)

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

• #due=(due : Array(VirtualTime))

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

• #due_on?(time : VirtualTime::TimeOrVirtualTime = Time.local, times = @due)
• #due_on_any_date?(time : VirtualTime::TimeOrVirtualTime = Time.local, times = @due)
• #due_on_any_time?(time : VirtualTime::TimeOrVirtualTime = Time.local, times = @due)
• #duration : Time::Span
• #duration=(duration : Time::Span)
• #end : VirtualTime::TimeOrVirtualTime | Nil

  Absolute end date/time.

• #end=(end __arg0 : VirtualTime::TimeOrVirtualTime | Nil)

  Absolute end date/time.

• #fixed : Bool

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

• #fixed=(fixed : Bool)

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

• #flags : Set(String)

  Flags/categories (e.g.

• #flags=(flags : Set(String))

  Flags/categories (e.g.

• #id : String

  Identifier (important for dependencies)

• #id=(id : String)

  Identifier (important for dependencies)

• #matches_any_date?(time : VirtualTime::TimeOrVirtualTime, times : Array(VirtualTime), default)
• #matches_any_time?(time : VirtualTime::TimeOrVirtualTime, times : Array(VirtualTime), default)
• #max_shift : Time::Span | Nil

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

• #max_shift=(max_shift : Time::Span | Nil)

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

• #max_shifts : Int32

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

• #max_shifts=(max_shifts : Int32)

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

• #omit : Array(VirtualTime)

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

• #omit=(omit : Array(VirtualTime))

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

• #omit_on?(time : VirtualTime::TimeOrVirtualTime = Time.local, times = @omit)
• #omit_on_dates?(time : VirtualTime::TimeOrVirtualTime = Time.local, times = @omit)
• #omit_on_times?(time : VirtualTime::TimeOrVirtualTime = Time.local, times = @omit)
• #on : Nil | Bool | Time::Span

  Fixed override of #on? for this vdate.

• #on=(on : Nil | Bool | Time::Span)

  Fixed override of #on? for this vdate.

• #on?(time : Time, *, max_shift = @max_shift, max_shifts = @max_shifts) : Bool

  Checks if the vdate is effectively scheduled at time.

• #parallel : Int32

  Max number of overlapping vdates that share at least one common flag with this vdate.

• #parallel=(parallel : Int32)

  Max number of overlapping vdates that share at least one common flag with this vdate.

• #priority : Int32

  Higher wins conflict resolution when Scheduler must choose.

• #priority=(priority : Int32)

  Higher wins conflict resolution when Scheduler must choose.

• #resolve(time : VirtualTime::TimeOrVirtualTime = Time.local, *, max_shift = @max_shift, max_shifts = @max_shifts, hint = time.is_a?(Time) ? time : Time.local) : Time | Bool | Nil

  Resolves the asked VirtualTime to an effective scheduled Time.

• #resolve_dependencies!(index : Hash(String, VirtualDate))
• #shift : Nil | Bool | Time::Span

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

• #shift=(shift : Nil | Bool | Time::Span)

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

• #stagger : Time::Span | Nil

  Optional staggered parallel scheduling

• #stagger=(stagger : Time::Span | Nil)

  Optional staggered parallel scheduling

• #strict_on?(time : VirtualTime::TimeOrVirtualTime = Time.local, *, max_shift = @max_shift, max_shifts = @max_shifts, hint = time.is_a?(Time) ? time : Time.local) : Nil | Bool | Time::Span

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

Constructor Detail

Instance Method Detail