Class RouteCheckSettings

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

What the user decides for one check of a PassagePlan: the mariner's depths, an optional corridor that replaces every leg's cross-track limits, and the time to judge at where the plan gives none. Engine tuning that stays the same between checks is in each check's options instead.

public sealed class RouteCheckSettings

Inheritance

object

RouteCheckSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Time follows one rule in every check: the ETA where a leg has one; else the plan's departure; else At.

Properties

AreaKindsOff

The kinds of prohibited area and area with special conditions whose indication is off (RouteAreaKinds; S-164 UserSelectionProhibited Areas). The areas of these kinds aren't reported; one AreaKindOff finding per kind says the route meets them. Empty by default: every kind is on.

public IReadOnlyCollection<int> AreaKindsOff { get; init; }

Property Value

IReadOnlyCollection<int>

At

The time to judge at where the plan has no departure, such as the view time or now. With a departure, legs without a speed are judged at the departure instead.

public required DateTimeOffset At { get; init; }

Property Value

DateTimeOffset

ChecksDepths

Whether the depth and danger checks run: both the safety contour and the safety depth are set.

public bool ChecksDepths { get; }

Property Value

bool

CorridorOverride

A half-width that replaces every leg's port and starboard limits, or null to use each leg's own.

public Length? CorridorOverride { get; init; }

Property Value

Length?

DepartureWindow

Departures to sweep for the clearance check, or null for none. The sweep is in Departures.

public DepartureRange? DepartureWindow { get; init; }

Property Value

DepartureRange

NearbyDistance

How far beyond a side's cross-track limit a danger or hazard is still near the route, or null for DangerNearbyMeters (0,1 NM by default).

public Length? NearbyDistance { get; init; }

Property Value

Length?

SafetyContour

The safety contour (S-101 PC parameter SafetyContour). Depth, dredged and drying areas and S-102 cells shallower than it are reported. With SafetyDepth, it enables the depth and danger checks; null skips them.

public Depth? SafetyContour { get; init; }

Property Value

Depth?

SafetyDepth

The safety depth (S-101 PC parameter SafetyDepth). Soundings and dangers shallower than it are reported. With SafetyContour, it enables the depth and danger checks; null skips them.

public Depth? SafetyDepth { get; init; }

Property Value

Depth?

TrackClearance

How close to the track line an aid to navigation, structure or overhead feature counts as on the track (#1127), or null for 30 m. A structure on the track must be reviewed; one elsewhere in the corridor is worth checking.

public Length? TrackClearance { get; init; }

Property Value

Length?

Methods

FromMarinerSettings(MarinerSettings, DateTimeOffset)

The settings for the mariner's safety contour and safety depth.

public static RouteCheckSettings FromMarinerSettings(MarinerSettings settings, DateTimeOffset at)

Parameters

settings MarinerSettings

The mariner's settings.

at DateTimeOffset

The time to judge at where the plan gives none.

Returns

RouteCheckSettings

The settings.