Class ClearanceCheck

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

The clearance check, built into RouteChecker: under-keel clearance over Depth and WaterLevel, with its findings from ClearanceFindings.

public sealed class ClearanceCheck : IRouteCheck<ClearanceCheckResult>, IRouteCheck

Inheritance

object

ClearanceCheck

Implements

IRouteCheck<ClearanceCheckResult>

IRouteCheck

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

At each sample's ETA, UKC = charted depth + water level − draft − squat, compared with the required UKC (0 m when unset). Charted depth comes from S-102 where it covers the route, otherwise from S-101 (marked low confidence). Water level comes from S-104 at the ETA; outside the S-104 extent or time range the sample is "no data" ("water level not applied"), never a charted-depth-only pass. The depth and water level must share a vertical datum (VerticalDatumCheck). With DepartureWindow it also sweeps departures (Departures).

Skipped without charted depth or water level (DepthMissing, WaterLevelMissing), or when any leg has no draft (DraftMissing).

It keeps the last depth profile and resamples only the legs whose points or geometry changed, so moving a waypoint resamples the two legs that meet there and changing the departure or the vessel values resamples nothing. It also keeps the last departure sweep, which a changed departure alone doesn't change. Its Detail is a ClearanceCheckResult.

This is an aid for exploring the data. It isn't for navigation.

Fields

CheckName

The check's Name.

public const string CheckName = "clearance"

Field Value

string

Properties

Name

The check's name in the report, such as "chart" or "clearance".

public string Name { get; }

Property Value

string

Methods

Run(RouteCheckContext, CancellationToken)

Runs the check.

public RouteCheckOutcome<ClearanceCheckResult> Run(RouteCheckContext context, CancellationToken cancellationToken = default)

Parameters

context RouteCheckContext

The plan, settings, sources and shared track.

cancellationToken CancellationToken

Cancels the check.

Returns

RouteCheckOutcome<ClearanceCheckResult>

The findings and the check's own result, or why the check was skipped.

Exceptions

ArgumentException

The PassageCheckOptions have a step, spacing or factor that isn't positive.