Class RainPointCalendarPreview

Namespace

RainPointClient

Assembly

RainPointClient.dll

A bounded, immutable calendar projection. Empty means no starts only when Availability is Decoded.

public sealed class RainPointCalendarPreview

Inheritance

object

RainPointCalendarPreview

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

Availability

Gets whether the entire requested projection could be decoded without guessing unsupported recurrence.

public TimerReadingAvailability Availability { get; }

Property Value

TimerReadingAvailability

FromDate

Gets the inclusive first home-local date of the projection.

public DateTime FromDate { get; }

Property Value

DateTime

Occurrences

Gets projected starts within the bounded window; availability determines whether an empty list is meaningful.

public IReadOnlyList<RainPointScheduleOccurrence> Occurrences { get; }

Property Value

IReadOnlyList<RainPointScheduleOccurrence>

ThroughDate

Gets the inclusive last home-local date of the projection.

public DateTime ThroughDate { get; }

Property Value

DateTime

Methods

GetNextOccurrence(DateTime)

First projected start at/after the supplied home-local wall time within this preview. Known rain-delayed starts are excluded. Inspect RainDelay: unknown settings do not imply no delay. Null is limited to this window, or unavailable projection.

public RainPointScheduleOccurrence? GetNextOccurrence(DateTime fromLocal)

Parameters

fromLocal DateTime

The home-local search instant within the preview window, with Unspecified kind.

Returns

RainPointScheduleOccurrence

The first eligible start in this preview, or null when unavailable or none exists within the bounded window.

Exceptions

ArgumentOutOfRangeException

The search must begin within the preview window.