Class PassageCheckOptions

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

Tuning for ClearanceCheck.

public sealed record PassageCheckOptions : IEquatable<PassageCheckOptions>

Inheritance

object

PassageCheckOptions

Implements

IEquatable<PassageCheckOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Default

The default options.

public static PassageCheckOptions Default { get; }

Property Value

PassageCheckOptions

GridStepFactor

The step along a leg as a fraction of the finest overlapping S-102 cell size, so no grid cell the leg crosses is stepped over. Default 0,5 (two steps per cell).

public double GridStepFactor { get; init; }

Property Value

double

MaxStepsPerLeg

The most steps taken along one leg. A longer leg over a very fine grid steps more coarsely rather than exceeding this. Default 250 000.

public int MaxStepsPerLeg { get; init; }

Property Value

int

MinimumLowConfidenceStretchMeters

Low-confidence stretches shorter than this, in metres, after merging, are left out of LowConfidence; the samples still carry their ConfidenceReasons. A passage shorter than this keeps its stretches. Gaps are always reported, however short, since they explain an incomplete-data verdict. Default 100 m.

public double MinimumLowConfidenceStretchMeters { get; init; }

Property Value

double

MinimumStepMeters

The smallest step along a leg, in metres. Default 0,5 m.

public double MinimumStepMeters { get; init; }

Property Value

double

SampleSpacingMeters

The longest stretch one reported sample stands for, in metres. Each reported sample carries the shoalest depth found in its stretch, so a longer spacing never hides a shoal; it only coarsens where along the stretch the shoal is placed. Default 50 m.

public double SampleSpacingMeters { get; init; }

Property Value

double

StretchMergeGapMeters

Stretches of one kind (in Gaps and LowConfidence) separated by less than this, in metres, are reported as one, so a ragged S-102 edge reads as one fallback stretch. Default 100 m.

public double StretchMergeGapMeters { get; init; }

Property Value

double

SubtractDepthUncertainty

When true, the S-102 uncertainty is subtracted from the charted depth before the clearance is computed (S-102 Ed 3.0.0 §6.5.1 says the uncertainty must be considered when classifying depths). Default false: the uncertainty is reported, not applied.

public bool SubtractDepthUncertainty { get; init; }

Property Value

bool

TightMarginMeters

How close to the required UKC counts as tight, in metres. Default 0,5 m ("Tight (within 0,5 m of required)").

public double TightMarginMeters { get; init; }

Property Value

double