Class DepartureSweep

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

Verdicts for a range of departures over the same route and depths.

public sealed record DepartureSweep : IEquatable<DepartureSweep>

Inheritance

object

DepartureSweep

Implements

IEquatable<DepartureSweep>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DepartureSweep(IReadOnlyList<DepartureOption>)

Verdicts for a range of departures over the same route and depths.

public DepartureSweep(IReadOnlyList<DepartureOption> Options)

Parameters

Options IReadOnlyList<DepartureOption>

One entry per departure, in time order.

Properties

Options

One entry per departure, in time order.

public IReadOnlyList<DepartureOption> Options { get; init; }

Property Value

IReadOnlyList<DepartureOption>

Step

The time between departures; Zero when unknown.

public TimeSpan Step { get; init; }

Property Value

TimeSpan

Methods

ArrivalAfterDataEnds()

The departures whose arrival is after the water-level data ends: the trailing run of WaterLevelEndsBeforeArrival options, as a (first, last) pair, or null when the last departure arrives within the data. These never meet your settings.

public (DateTimeOffset First, DateTimeOffset Last)? ArrivalAfterDataEnds()

Returns

(DateTimeOffset First, DateTimeOffset Last)?

The span, or null.

MeetingConfidence()

The low-confidence reasons of the departures that meet your settings, combined: the caveat on the departure window.

public ConfidenceReasons MeetingConfidence()

Returns

ConfidenceReasons

The reasons, or None.

NearestMeeting(DateTimeOffset)

The meeting departure nearest departure, or null when none meets.

public DepartureOption? NearestMeeting(DateTimeOffset departure)

Parameters

departure DateTimeOffset

The reference departure.

Returns

DepartureOption

The nearest meeting option, or null.

Windows()

The contiguous runs of departures that meet your settings, as (first, last) departure pairs.

public IReadOnlyList<(DateTimeOffset First, DateTimeOffset Last)> Windows()

Returns

IReadOnlyList<(DateTimeOffset First, DateTimeOffset Last)>