Class RouteCheckReport

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

Everything one Check(PassagePlan, RouteCheckSettings, CancellationToken) run found: the findings of every check in one sorted list, the verdict, whether each check ran, and each built-in check's own result.

public sealed class RouteCheckReport

Inheritance

object

RouteCheckReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

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

Properties

Areas

Every area near the route, in force or not; empty when the area check didn't run.

public IReadOnlyList<RouteAreaMatch> Areas { get; }

Property Value

IReadOnlyList<RouteAreaMatch>

Chart

The chart check's result, with each leg's corridor, or null when it didn't run.

public ChartCheckResult? Chart { get; }

Property Value

ChartCheckResult

Checks

Whether each check ran, in the order they ran.

public IReadOnlyList<RouteCheckStatus> Checks { get; }

Property Value

IReadOnlyList<RouteCheckStatus>

Clearance

The clearance check's result, or null when it didn't run.

public PassageCheckResult? Clearance { get; }

Property Value

PassageCheckResult

Counts

The number of findings in each group.

public RouteFindingCounts Counts { get; }

Property Value

RouteFindingCounts

DatasetsUsed

The ids of the datasets behind the report, sorted: the chart cells along the corridors, the datasets behind the findings, and the depth and water-level datasets the clearance check read.

public IReadOnlyList<string> DatasetsUsed { get; }

Property Value

IReadOnlyList<string>

Departures

The sweep of DepartureWindow, or null.

public DepartureSweep? Departures { get; }

Property Value

DepartureSweep

Findings

Every check's findings, sorted by group (MUST REVIEW, CHECK, INFO) and then by distance from departure.

public IReadOnlyList<RouteFinding> Findings { get; }

Property Value

IReadOnlyList<RouteFinding>

Plan

The plan that was checked.

public PassagePlan Plan { get; }

Property Value

PassagePlan

Schedule

The ETAs the checks judged times with.

public PassageSchedule Schedule { get; }

Property Value

PassageSchedule

Settings

The settings it was checked with.

public RouteCheckSettings Settings { get; }

Property Value

RouteCheckSettings

Track

The plan's track.

public RouteTrack Track { get; }

Property Value

RouteTrack

Verdict

The verdict and the finding that names it.

public RouteCheckVerdict Verdict { get; }

Property Value

RouteCheckVerdict

Warnings

Every warning near the route, in force or not; empty when the warning check didn't run.

public IReadOnlyList<RouteWarningMatch> Warnings { get; }

Property Value

IReadOnlyList<RouteWarningMatch>

Methods

Detail<T>(string)

The Detail of the check named name, or null when it didn't run or its detail isn't a T.

public T? Detail<T>(string name) where T : class

Parameters

name string

The check's Name.

Returns

T

The detail.

Type Parameters

T

The detail's type.

Status(string)

The status of the check named name, or null when no check has that name.

public RouteCheckStatus? Status(string name)

Parameters

name string

The check's Name.

Returns

RouteCheckStatus

The status.