Class RouteCheckOutcome

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

What one check found, or why it didn't run.

public class RouteCheckOutcome

Inheritance

object

RouteCheckOutcome

Derived

RouteCheckOutcome<TDetail>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A check with a typed result returns a RouteCheckOutcome<TDetail>.

Properties

Detail

The check's own result, such as a ChartCheckResult for the chart check, or null. Detail gives it typed.

public object? Detail { get; }

Property Value

object

Findings

The findings, in any order; empty when skipped.

public IReadOnlyList<RouteFinding> Findings { get; }

Property Value

IReadOnlyList<RouteFinding>

Reason

Why the check was skipped or ran only in part, such as DraftMissing; null when it ran in full.

public string? Reason { get; }

Property Value

string

State

Whether the check ran.

public RouteCheckState State { get; }

Property Value

RouteCheckState

Methods

Partial(string, IReadOnlyList<RouteFinding>, object?)

A check that ran, but part of it couldn't.

public static RouteCheckOutcome Partial(string reason, IReadOnlyList<RouteFinding> findings, object? detail = null)

Parameters

reason string

Why part of it didn't run.

findings IReadOnlyList<RouteFinding>

The findings of the part that ran.

detail object

The check's own result, or null.

Returns

RouteCheckOutcome

The outcome.

Ran(IReadOnlyList<RouteFinding>, object?)

A check that ran in full.

public static RouteCheckOutcome Ran(IReadOnlyList<RouteFinding> findings, object? detail = null)

Parameters

findings IReadOnlyList<RouteFinding>

The findings.

detail object

The check's own result, or null.

Returns

RouteCheckOutcome

The outcome.

Skipped(string)

A check that didn't run.

public static RouteCheckOutcome Skipped(string reason)

Parameters

reason string

Why, such as DraftMissing.

Returns

RouteCheckOutcome

The outcome.