Class LegUkcResult

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

The check result for one leg.

public sealed record LegUkcResult : IEquatable<LegUkcResult>

Inheritance

object

LegUkcResult

Implements

IEquatable<LegUkcResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LegUkcResult(int, string?, double, double, DateTimeOffset?, DateTimeOffset?, int, int, UkcMinimum?, UkcState, double, int, ConfidenceReasons, bool)

The check result for one leg.

public LegUkcResult(int LegIndex, string? Name, double StartDistanceMeters, double DistanceMeters, DateTimeOffset? Start, DateTimeOffset? End, int FirstSample, int SampleCount, UkcMinimum? Minimum, UkcState WorstState, double MinutesBelow, int PlacesBelow, ConfidenceReasons Confidence, bool HasNoWaterLevel)

Parameters

LegIndex int

Index of the leg.

Name string

The leg's display name, when the caller gave one.

StartDistanceMeters double

Distance from the start of the passage to the start of the leg.

DistanceMeters double

Length of the leg.

Start DateTimeOffset?

ETA at the start of the leg, or null when unknown.

End DateTimeOffset?

ETA at the end of the leg, or null when unknown.

FirstSample int

Index of the leg's first sample.

SampleCount int

Number of samples on the leg.

Minimum UkcMinimum

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

WorstState UkcState

The worst state among the leg's samples.

MinutesBelow double

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

PlacesBelow int

Number of separate stretches below the setting on this leg.

Confidence ConfidenceReasons

The low-confidence reasons of every sample on the leg, combined.

HasNoWaterLevel bool

true when any sample on the leg has a charted depth but no applied water level.

Properties

Confidence

The low-confidence reasons of every sample on the leg, combined.

public ConfidenceReasons Confidence { get; init; }

Property Value

ConfidenceReasons

DistanceMeters

Length of the leg.

public double DistanceMeters { get; init; }

Property Value

double

End

ETA at the end of the leg, or null when unknown.

public DateTimeOffset? End { get; init; }

Property Value

DateTimeOffset?

FirstSample

Index of the leg's first sample.

public int FirstSample { get; init; }

Property Value

int

HasLowConfidence

true when any sample on the leg is lower confidence.

public bool HasLowConfidence { get; }

Property Value

bool

HasNoWaterLevel

true when any sample on the leg has a charted depth but no applied water level.

public bool HasNoWaterLevel { get; init; }

Property Value

bool

LegIndex

Index of the leg.

public int LegIndex { get; init; }

Property Value

int

Minimum

The leg's 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 on this leg, in minutes (0 without ETAs).

public double MinutesBelow { get; init; }

Property Value

double

Name

The leg's display name, when the caller gave one.

public string? Name { get; init; }

Property Value

string

PlacesBelow

Number of separate stretches below the setting on this leg.

public int PlacesBelow { get; init; }

Property Value

int

SampleCount

Number of samples on the leg.

public int SampleCount { get; init; }

Property Value

int

Start

ETA at the start of the leg, or null when unknown.

public DateTimeOffset? Start { get; init; }

Property Value

DateTimeOffset?

StartDistanceMeters

Distance from the start of the passage to the start of the leg.

public double StartDistanceMeters { get; init; }

Property Value

double

WorstState

The worst state among the leg's samples.

public UkcState WorstState { get; init; }

Property Value

UkcState