Class RouteCheckOptions

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

Tuning for a RouteChecker: one set for every check, set once rather than per run. What the user decides on each run is in RouteCheckSettings.

public sealed record RouteCheckOptions : IEquatable<RouteCheckOptions>

Inheritance

object

RouteCheckOptions

Implements

IEquatable<RouteCheckOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Areas

Tuning for AreaCheck.

public RouteAreaOptions Areas { get; init; }

Property Value

RouteAreaOptions

Chart

Tuning for ChartCheck.

public ChartCheckOptions Chart { get; init; }

Property Value

ChartCheckOptions

Clearance

Tuning for ClearanceCheck.

public PassageCheckOptions Clearance { get; init; }

Property Value

PassageCheckOptions

Default

The default options.

public static RouteCheckOptions Default { get; }

Property Value

RouteCheckOptions

DefaultLimit

The corridor's half-width on a side whose cross-track limit isn't set: how far it reaches to port, or to starboard, of the track. The full corridor is twice this when neither side is set. Every check uses it. Default 50 m.

public Length DefaultLimit { get; init; }

Property Value

Length

Formatter

Renders every finding's title and meta line. Hosts with their own resources (the viewer's Strings.resx) pass their own.

public RouteFindingFormatter Formatter { get; init; }

Property Value

RouteFindingFormatter

Warnings

Tuning for WarningCheck.

public RouteWarningOptions Warnings { get; init; }

Property Value

RouteWarningOptions