Namespace EncDotNet.S100.Navigation

AreaCheck

The area check, built into RouteChecker: checks the route against regulated areas (#956): S-101 restricted, military practice, caution, anchorage and traffic areas, and S-122 marine protected and restricted areas. It finds which the track enters or which reach inside its cross-track limits, and whether each is in force while the vessel is there.

AreaCheckResult

What AreaCheck found besides its findings: every area near the route.

AreaDetails

A regulated area the route meets (Area): what it is, what it restricts and when it's in force.

AreaKindOffDetails

Areas of a kind the settings turn off (AreaKindsOff) that the route meets (AreaKindOff, #1127): their indication is off, so the mariner is told so.

ChartCheck

The chart check, built into RouteChecker: where the route's track crosses land or drying ground, where either reaches into the corridor between its cross-track limits, and where it leaves the loaded charts (#888, #954), over Charts. When ChecksDepths it also checks charted dangers and the safety contour and depth (#955), judging each leg's dangers against that leg's keel when it has a draft.

ChartCheckOptions

Tuning for ChartCheck.

ChartCheckResult

What ChartCheck found besides its findings: the corridor it swept along each leg.

ChartedDepth

A charted depth at a point and where it came from.

ChartedDepthResolver

The depth priority chain shared by the viewer's pick report and the passage check: S-102 bathymetry, then S-101 DredgedArea, then S-101 DepthArea, then the nearest S-101 Sounding.

ClearanceCheck

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

ClearanceCheckResult

What ClearanceCheck found besides its findings: the clearance and the departure sweep.

ClearanceDetails

A finding of the clearance check: a stretch below your UKC setting (BelowSetting), or a stretch of lower confidence or missing data (Stretch).

ClearanceFindings

The findings of a clearance check (#905, handoff F4): each stretch below your UKC setting, each lower-confidence stretch, and each water-level or depth gap of a PassageCheckResult.

DangerDetails

A charted danger in or near the corridor (DangerInCorridor, DangerNearRoute).

DepartureOption

The outcome of one departure in a DepartureSweep.

DepartureRange

The departures a clearance check sweeps (DepartureWindow): a fixed range, or the span of the water-level data that covers the route.

DepartureSweep

Verdicts for a range of departures over the same route and depths.

HazardDetails

A charted navigational hazard other than a danger in or near the corridor: an aid to navigation, a structure or an overhead feature whose S-101 portrayal raises the NavHazard alert (#1127).

LegSchedule

The timing of one leg within a PassageSchedule.

LegUkcResult

The check result for one leg.

PassageCheckOptions

Tuning for ClearanceCheck.

PassageCheckResult

The result of a passage check.

PassageGeodesy

Distances and interpolation along rhumb lines and great circles on the WGS-84 ellipsoid, used to measure legs and to place samples along them.

PassageLeg

One leg of a passage: its track, its cross-track limits, and the vessel values that apply on it. Every check reads its legs from here. Callers resolve inheritance (route values, per-leg overrides) before building a leg, so every value here is the effective one.

PassagePlan

A passage to check: its legs in order and, when known, the departure time.

PassageSchedule

Distances, durations and ETAs for a passage at a constant speed over ground on each leg. Build one with Compute(PassagePlan, RouteCheckSettings).

PassageSources

The datasets and datums behind a result, for the Sources disclosure.

PassageStretch

A run of consecutive samples that share a gap or a low-confidence reason.

RouteArea

One regulated area to check a route against: an S-101 restricted, caution, anchorage or traffic area, or an S-122 protected area.

RouteAreaDateRange

An S-100 date range (fixedDateRange or periodicDateRange) as its text: S100_TruncatedDate dates (2026-03-01, 20260301, or without a year, --03-01, ----0301) and optional times of day.

RouteAreaKinds

The kinds of prohibited area and area with special conditions in the S-101 alert catalogue (#1127): the viewing groups of its ProhAre highlight, which each area's AlertReference names, and the names MCP and s100 route check use for them.

RouteAreaMatch

One area against the route, found or not.

RouteAreaOptions

Tuning for AreaCheck.

RouteChartAlert

An alert a charted feature's portrayal raises (#1127).

RouteChartCell

A loaded chart cell, as the route check sees it: its scale rank and the area it declares coverage for.

RouteChartFeature

A charted feature near a route leg: its kind, the cell it comes from, its geometry in WGS-84, and the depth it charts.

RouteChartQuery

What a chart source needs to know to portray a corridor's features as the check sees them: the depths the S-101 alert rules compare against.

RouteCheckContext

What every check of one Check(PassagePlan, RouteCheckSettings, CancellationToken) run reads: the plan, settings, sources and options, and the track and schedule built once for all of them.

RouteCheckCorridor

The corridor the check swept along one leg.

RouteCheckOptions

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.

RouteCheckOutcome

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

RouteCheckOutcome<TDetail>

What one check found, with its own typed result, or why it didn't run.

RouteCheckReasons

Why a built-in check was skipped or ran only in part. A custom check may give its own reasons.

RouteCheckReport

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.

RouteCheckSettings

What the user decides for one check of a PassagePlan: the mariner's depths, an optional corridor that replaces every leg's cross-track limits, and the time to judge at where the plan gives none. Engine tuning that stays the same between checks is in each check's options instead.

RouteCheckSources

Everything the route checks read from loaded data, as one bundle: the charted features, charted depth, water level, regulated areas and navigational warnings. A host builds one per set of loaded datasets (CatalogRouteCheckSources in EncDotNet.S100.Datasets.Pipelines) and checks as often as the route changes.

RouteCheckStatus

Whether one check of a RouteCheckReport ran, and why not.

RouteCheckVerdict

The one answer of a route check, and the finding that names it.

RouteChecker

Checks a PassagePlan against one set of loaded data with every check, and returns one RouteCheckReport: the findings, the verdict and whether each check ran.

RouteFinding

One entry in a route's findings list (#905): what a route check found, where it is, the numbers behind it (Details), and its text as a RouteFindingFormatter rendered it.

RouteFindingCode

The kind of a RouteFinding: its stable code, what it's about, the group it's in unless the check says otherwise, and its rank when a verdict names the worst finding.

RouteFindingCodes

Every code a route check gives its findings.

RouteFindingCounts

The number of findings in each group.

RouteFindingDetails

The numbers behind a RouteFinding, by kind, so a client gets the depth that fired or an area's restrictions without parsing its text: DangerDetails, ShoalDetails, AreaDetails, WarningDetails or ClearanceDetails.

RouteFindingFeature

A feature behind a finding, which pick and describe can open.

RouteFindingFormatter

Renders a RouteFinding's Title and Meta from its code and Details.

RouteFindingLocation

Where a finding is: a point, or a span of the route between two distances from departure.

RouteHazardClasses

The hazard class of each S-101 feature type whose portrayal can raise the NavHazard alert (#1127), from the route-findings design (docs/design/route-findings-volume.md §4.1).

RouteTrack

The track of a PassagePlan, built once per check and shared by every check: each leg's distances and corridor half-widths, and the position at a distance from departure.

RouteTrackLeg

One leg of a RouteTrack: where it runs and how far its corridor reaches.

RouteWarning

One navigational warning part to check a route against.

RouteWarningList

An IRouteWarningSource over a list of warning parts.

RouteWarningMatch

One warning against the route, found or not.

RouteWarningOptions

Tuning for WarningCheck.

ShoalDetails

Water shallower than a safety setting: depth areas across or inside the safety contour, soundings no deeper than the safety contour, and S-102 shoals (CrossesSafetyContour and the like).

SkinOfTheEarth

Classifies S-101 skin-of-the-earth areas as water or land, and depth areas as drying. Shared by the viewer's pick-time water/land decision and the route check (#954).

UkcMinimum

The smallest margin over the required UKC, and where and when it occurs.

UkcSample

One sample along the passage.

UkcWaterLevel

The water level at a sample.

VerticalDatumCheck

Compares the vertical datums of a charted depth and a water level.

WarningCheck

The warning check, built into RouteChecker: checks the route against navigational warnings (S-124 Editions 1.0.0 and 2.0.0, #957): which cross its corridor or come near it, and whether each is in force while the vessel is there.

WarningCheckResult

What WarningCheck found besides its findings: every warning near the route.

WarningDetails

An S-124 finding's warning, and how it stands on the route.

WaterLevelAtPoint

What a IWaterLevelField found at a point: whether a water level applies, and if not, why.

WaterLevelBasis

What a IWaterLevelField applies: the time or period, and the datasets it reads.

WaterLevelPeriodMinimum

The lowest water level at each point over a period (S-98 Appendix D-2.5, S-164 WLATimePeriod): the conservative choice for a passage window.

WaterLevelPreference

The rule for choosing between overlapping gridded S-104 datasets, shared with the viewer's pick report: the finest grid wins, then the latest issue, then the ordinally smaller dataset id so the choice never depends on load order.

WaterLevelSnapshot

The water level at one instant, from an IWaterLevelSource.

WaterLevelSourceInfo

Where a water-level series comes from.

AppliedWaterLevel

A water level to apply at a point.

WaterLevelReading

A water-level height read from a series.

IChartedDepthSource

Supplies charted depth at a point: S-102 bathymetry, with S-101 as the fallback where no S-102 covers it. The clearance check reads the whole chain (Sample(GeoPosition)); the chart check's S-102 shoal test reads S-102 only (SampleBathymetry(GeoPosition)), so one source serves both.

IRouteAreaSource

Supplies the regulated areas a AreaCheck checks a route against. EncDotNet.S100.Datasets.Pipelines implements it over loaded S-101 cells and S-122 datasets (CatalogRouteCheckSources).

IRouteChartSource

Supplies the charted features a ChartCheck checks a route against. EncDotNet.S100.Datasets.Pipelines implements it over loaded S-101 cells (CatalogRouteCheckSources).

IRouteCheck

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

IRouteCheck<TDetail>

A check whose outcome carries its own typed result, such as ChartCheck with its ChartCheckResult, so a caller that runs it directly reads the result without a cast.

IRouteWarningSource

Supplies the navigational warnings a WarningCheck checks a route against. EncDotNet.S100.Datasets.Pipelines implements it over loaded S-124 datasets; RouteWarningList implements it over a list a host already has.

IWaterLevelField

The water level to apply across an area, for one time or period: the model the pick report, and later the chart, read, built on the same IWaterLevelSource and series rule as the passage check so the three give one answer for a point and time.

IWaterLevelSeries

The water-level time series at one place: a grid cell or a station.

IWaterLevelSource

Finds the water-level series that apply at a point.

ChartedDepthKind

Which kind of source supplied a charted depth, in the priority order the ChartedDepthResolver applies.

ClearanceBand

How the clearance compares with the required UKC, ignoring confidence.

ConfidenceReasons

Why a sample, a leg or a departure is lower confidence. Confidence is shown alongside the clearance band, never in place of it.

DatumAgreement

Whether a depth and a water level share a vertical datum.

LegGeometry

How a leg runs between its points.

PassageStretchKind

Kinds of PassageStretch.

PassageVerdict

The headline answer for a passage, in the handoff's C3 title priority.

RouteAreaKind

What an area is, as the area check sees it.

RouteAreaProduct

The product an area comes from.

RouteAreaRelation

How an area relates to a route.

RouteChartFeatureKind

What a charted feature means to the route check. Restricted and protected areas (#956) and S-124 warnings (#957) have their own checks (AreaCheck, WarningCheck).

RouteCheckState

Whether a check ran.

RouteCheckVerdictKind

The verdict of a route check, worst first.

RouteFindingAlert

An alert in the S-101 alert catalogue: what a feature's portrayal says a route crossing it should raise (S-100 Part 9 alertReference, S-98 §12.10).

RouteFindingCategory

What a finding is about. Every RouteFindingCode belongs to one category (Category), so a host can filter or tag findings without matching their codes.

RouteFindingGroup

What a finding asks the navigator to do, which is how the findings list groups it (MUST REVIEW, CHECK, INFO).

RouteFindingPosition

Where something lies from the track (#1127).

RouteFindingSide

Which side of the track something is on.

RouteFindingThreshold

The depth a charted depth was found shallower than.

RouteHazardClass

What kind of navigational hazard a feature is (#1127): what the mariner asks about it. A feature type RouteHazardClasses doesn't know is a Structure, so no hazard is lost.

RouteWarningRelation

How a warning's geometry relates to a route.

RouteWarningStatus

Whether a warning applies while the vessel is at it.

SkinOfTheEarthClass

What an S-101 skin-of-the-earth (group 1) area says about the ground under it.

UkcState

The state of a sample, a leg or a stretch, in the handoff's words.

WaterLevelBasisKind

Which time a IWaterLevelField is for.

WaterLevelSourceKind

The encoding of an S-104 water-level source.