Class UkcSample

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

One sample along the passage.

public sealed record UkcSample : IEquatable<UkcSample>

Inheritance

object

UkcSample

Implements

IEquatable<UkcSample>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

UkcSample(int, int, GeoPosition, double, double, double, DateTimeOffset, bool, ChartedDepth?, UkcWaterLevel, double, double, double, double?, ClearanceBand?, UkcState, ConfidenceReasons)

One sample along the passage.

public UkcSample(int Index, int LegIndex, GeoPosition Position, double DistanceMeters, double StartDistanceMeters, double EndDistanceMeters, DateTimeOffset Time, bool HasEta, ChartedDepth? Depth, UkcWaterLevel WaterLevel, double DraftMeters, double SquatMeters, double RequiredUkcMeters, double? ClearanceMeters, ClearanceBand? Band, UkcState State, ConfidenceReasons Confidence = ConfidenceReasons.None)

Parameters

Index int

Index of the sample in Samples.

LegIndex int

Index of the leg the sample is on.

Position GeoPosition

Where the sample's charted depth was read: the shoalest point in its stretch.

DistanceMeters double

Distance from the start of the passage to Position.

StartDistanceMeters double

Distance from the start of the passage to the start of the stretch this sample stands for.

EndDistanceMeters double

Distance from the start of the passage to the end of the stretch this sample stands for.

Time DateTimeOffset

The ETA at the sample, or the departure time when ETAs are unknown.

HasEta bool

true when Time is a real ETA; false when the leg has no speed.

Depth ChartedDepth

The charted depth, or null when no source covers the sample.

WaterLevel UkcWaterLevel

The water level and whether it was applied.

DraftMeters double

The draft on the sample's leg.

SquatMeters double

The squat allowance on the sample's leg.

RequiredUkcMeters double

The required UKC on the sample's leg (0 when unset).

ClearanceMeters double?

UKC = charted depth + water level − draft − squat, or null when either the depth or an applicable water level is missing.

Band ClearanceBand?

How the clearance compares with the required UKC, or null without a clearance.

State UkcState

The sample's state.

Confidence ConfidenceReasons

Why the sample is lower confidence, or None. Independent of State: a no-data sample can carry ChartedDepthFromS101 too.

Properties

Band

How the clearance compares with the required UKC, or null without a clearance.

public ClearanceBand? Band { get; init; }

Property Value

ClearanceBand?

ClearanceMeters

UKC = charted depth + water level − draft − squat, or null when either the depth or an applicable water level is missing.

public double? ClearanceMeters { get; init; }

Property Value

double?

Confidence

Why the sample is lower confidence, or None. Independent of State: a no-data sample can carry ChartedDepthFromS101 too.

public ConfidenceReasons Confidence { get; init; }

Property Value

ConfidenceReasons

Depth

The charted depth, or null when no source covers the sample.

public ChartedDepth? Depth { get; init; }

Property Value

ChartedDepth

DistanceMeters

Distance from the start of the passage to Position.

public double DistanceMeters { get; init; }

Property Value

double

DraftMeters

The draft on the sample's leg.

public double DraftMeters { get; init; }

Property Value

double

EndDistanceMeters

Distance from the start of the passage to the end of the stretch this sample stands for.

public double EndDistanceMeters { get; init; }

Property Value

double

HasEta

true when Time is a real ETA; false when the leg has no speed.

public bool HasEta { get; init; }

Property Value

bool

Index

Index of the sample in Samples.

public int Index { get; init; }

Property Value

int

IsLowConfidence

true when Confidence has any reason.

public bool IsLowConfidence { get; }

Property Value

bool

LegIndex

Index of the leg the sample is on.

public int LegIndex { get; init; }

Property Value

int

Position

Where the sample's charted depth was read: the shoalest point in its stretch.

public GeoPosition Position { get; init; }

Property Value

GeoPosition

RequiredUkcMeters

The required UKC on the sample's leg (0 when unset).

public double RequiredUkcMeters { get; init; }

Property Value

double

SquatMeters

The squat allowance on the sample's leg.

public double SquatMeters { get; init; }

Property Value

double

StartDistanceMeters

Distance from the start of the passage to the start of the stretch this sample stands for.

public double StartDistanceMeters { get; init; }

Property Value

double

State

The sample's state.

public UkcState State { get; init; }

Property Value

UkcState

Time

The ETA at the sample, or the departure time when ETAs are unknown.

public DateTimeOffset Time { get; init; }

Property Value

DateTimeOffset

WaterLevel

The water level and whether it was applied.

public UkcWaterLevel WaterLevel { get; init; }

Property Value

UkcWaterLevel