Interface IRouteCheck

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

One check a RouteChecker runs: the chart, area, warning and clearance checks are built in, and a host can add its own.

public interface IRouteCheck

Remarks

A check reads the plan, settings, sources and shared track from the RouteCheckContext. It says when it can't run, with a reason, rather than returning no findings (Skipped(string)).

One check object serves every run of its checker, possibly on several threads at once, so any state it keeps between runs (a cache) must be safe for that.

Properties

Name

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

string Name { get; }

Property Value

string

Methods

Run(RouteCheckContext, CancellationToken)

Runs the check.

RouteCheckOutcome Run(RouteCheckContext context, CancellationToken cancellationToken)

Parameters

context RouteCheckContext

The plan, settings, sources and shared track.

cancellationToken CancellationToken

Cancels the check.

Returns

RouteCheckOutcome

The findings, or why the check was skipped.