Class PassagePlan

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

A passage to check: its legs in order and, when known, the departure time.

public sealed class PassagePlan

Inheritance

object

PassagePlan

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PassagePlan(IReadOnlyList<PassageLeg>, DateTimeOffset?)

Creates the plan.

public PassagePlan(IReadOnlyList<PassageLeg> legs, DateTimeOffset? departure = null)

Parameters

legs IReadOnlyList<PassageLeg>

The legs in route order. Each leg starts where the previous one ends.

departure DateTimeOffset?

The departure time from the first point, or null when the route has none; the checks then use At.

Properties

Departure

The departure time from the first point, or null when the route has none.

public DateTimeOffset? Departure { get; }

Property Value

DateTimeOffset?

Legs

The legs in route order.

public IReadOnlyList<PassageLeg> Legs { get; }

Property Value

IReadOnlyList<PassageLeg>

Methods

EffectiveDeparture(RouteCheckSettings)

The departure the checks use: Departure, or settings' At when the plan has none.

public DateTimeOffset EffectiveDeparture(RouteCheckSettings settings)

Parameters

settings RouteCheckSettings

The check settings.

Returns

DateTimeOffset

The effective departure.

WithDeparture(DateTimeOffset?)

A copy of the plan with a different departure.

public PassagePlan WithDeparture(DateTimeOffset? departure)

Parameters

departure DateTimeOffset?

The departure, or null.

Returns

PassagePlan

The plan.