Class PassageCheckResult

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

The result of a passage check.

public sealed record PassageCheckResult : IEquatable<PassageCheckResult>

Inheritance

object

PassageCheckResult

Implements

IEquatable<PassageCheckResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PassageCheckResult(DateTimeOffset, DateTimeOffset?, PassageVerdict, bool, UkcMinimum?, double, int, IReadOnlyList<UkcSample>, IReadOnlyList<LegUkcResult>, IReadOnlyList<PassageStretch>, IReadOnlyList<PassageStretch>, PassageSources, ConfidenceReasons)

The result of a passage check.

public PassageCheckResult(DateTimeOffset Departure, DateTimeOffset? Arrival, PassageVerdict Verdict, bool NoMarginSet, UkcMinimum? Minimum, double MinutesBelow, int PlacesBelow, IReadOnlyList<UkcSample> Samples, IReadOnlyList<LegUkcResult> Legs, IReadOnlyList<PassageStretch> Gaps, IReadOnlyList<PassageStretch> LowConfidence, PassageSources Sources, ConfidenceReasons Confidence = ConfidenceReasons.None)

Parameters

Departure DateTimeOffset

The departure time.

Arrival DateTimeOffset?

The arrival time, or null when any leg has no speed.

Verdict PassageVerdict

The headline answer.

NoMarginSet bool

true when any leg has no required UKC, so it was checked against 0 m.

Minimum UkcMinimum

The smallest margin over the required UKC, or null when no sample has a clearance.

MinutesBelow double

Time spent below the setting, in minutes (0 without ETAs).

PlacesBelow int

Number of separate stretches below the setting.

Samples IReadOnlyList<UkcSample>

Every sample in passage order.

Legs IReadOnlyList<LegUkcResult>

Per-leg results in route order.

Gaps IReadOnlyList<PassageStretch>

Stretches with no data, or where the datums don't match.

LowConfidence IReadOnlyList<PassageStretch>

Stretches charted from S-101, or where the datums can't be confirmed.

Sources PassageSources

The datasets and datums behind the result.

Confidence ConfidenceReasons

The low-confidence reasons of every sample, combined.

Properties

Arrival

The arrival time, or null when any leg has no speed.

public DateTimeOffset? Arrival { get; init; }

Property Value

DateTimeOffset?

Confidence

The low-confidence reasons of every sample, combined.

public ConfidenceReasons Confidence { get; init; }

Property Value

ConfidenceReasons

Departure

The departure time.

public DateTimeOffset Departure { get; init; }

Property Value

DateTimeOffset

Gaps

Stretches with no data, or where the datums don't match.

public IReadOnlyList<PassageStretch> Gaps { get; init; }

Property Value

IReadOnlyList<PassageStretch>

Legs

Per-leg results in route order.

public IReadOnlyList<LegUkcResult> Legs { get; init; }

Property Value

IReadOnlyList<LegUkcResult>

LowConfidence

Stretches charted from S-101, or where the datums can't be confirmed.

public IReadOnlyList<PassageStretch> LowConfidence { get; init; }

Property Value

IReadOnlyList<PassageStretch>

Minimum

The smallest margin over the required UKC, or null when no sample has a clearance.

public UkcMinimum? Minimum { get; init; }

Property Value

UkcMinimum

MinutesBelow

Time spent below the setting, in minutes (0 without ETAs).

public double MinutesBelow { get; init; }

Property Value

double

NoMarginSet

true when any leg has no required UKC, so it was checked against 0 m.

public bool NoMarginSet { get; init; }

Property Value

bool

PlacesBelow

Number of separate stretches below the setting.

public int PlacesBelow { get; init; }

Property Value

int

Samples

Every sample in passage order.

public IReadOnlyList<UkcSample> Samples { get; init; }

Property Value

IReadOnlyList<UkcSample>

Sources

The datasets and datums behind the result.

public PassageSources Sources { get; init; }

Property Value

PassageSources

Verdict

The headline answer.

public PassageVerdict Verdict { get; init; }

Property Value

PassageVerdict