Namespace EncDotNet.S100.Datasets.Pipelines.Query

Classes

CoverageFieldsSample

The generic sample shape: a list of SampledFields plus where and when they were read. Returned by a product that has no typed shape of its own, so its values reach MCP callers with no tool changes. Written with the JSON $kind "fields".

CoverageReading

What reading a CoverageSampleSite produced.

CoverageReading.NoData

The cell carries the no-data fill value.

CoverageReading.NotSupported

The dataset is of the product but this shape of it cannot be sampled yet.

CoverageReading.OutsideGrid

The point is outside the grid at the step read.

CoverageReading.Series

The values of a windowed query.

CoverageReading.Value

A value.

CoverageSampleOutcome<TSource>

What CoverageSampling produced.

CoverageSampleOutcome<TSource>.NoCoverage

No dataset covers the point.

CoverageSampleOutcome<TSource>.NoData

The chosen cell carries the no-data fill value.

CoverageSampleOutcome<TSource>.NotSupported

The product is sampled, but not this shape of dataset or query.

CoverageSampleOutcome<TSource>.OutsideGrid

Datasets of the product are loaded, but the point is outside every grid.

CoverageSampleOutcome<TSource>.Sampled

A value.

CoverageSampleOutcome<TSource>.SourceClosed

The dataset was closed while it was being read.

CoverageSampleOutcome<TSource>.TimeOutOfRange

The requested time lies outside the time range of every candidate.

CoverageSampleQuery

A point to sample, passed to FindSites(CoverageSampleQuery).

CoverageSampleSite

One place in a dataset that can answer a sample — a grid node or a station — found by FindSites(CoverageSampleQuery).

CoverageSamplerEntry<TSource>

An ICoverageSampler to sample, with the host's handle for it.

CoverageSamplerExtensions

Sampling of a single ICoverageSampler: at a point and time, over a time window, and along a polyline. Each is CoverageSampling with one dataset.

CoverageSampling

Samples one or more ICoverageSamplers at a point: chooses the dataset and site that answer, applies the time handling, and reads it. Shared by the sample_coverage tools and by CoverageSamplerExtensions, so every product treats time the same way.

CoverageSiteSearch

What an ICoverageSampler found at a point.

CoverageTimeRange<TSource>

A candidate's time range, as listed in Candidates.

CoverageTimeWindow

A range or series time query for SampleWindow<TSource>(IReadOnlyList<CoverageSamplerEntry<TSource>>, CoverageSampleQuery, CoverageTimeWindow).

CoverageTimedSample

One entry of a windowed sample.

DatasetClosedDuringQuery

The dataset was unloaded after the catalog snapshot was taken but before the read completed.

DatasetLoadFailed

A dataset path was recognised but produced no portrayable dataset — for example an exchange set that contained no datasets the host can portray, or a file that loaded but yielded nothing. Distinguished from InvalidArgument in that the argument was well-formed and the path existed; the load itself produced no usable result.

DatasetNotFound

The named dataset is not present in the catalog snapshot.

DatasetTimeRange

A candidate dataset's time range, as listed in Candidates.

DepthSample

S-102 depth sample (metres below the vertical datum, positive down).

DescribeFeatureRequest

Request payload for DescribeFeatureService.

DescribeFeatureResult

Result of DescribeFeatureService.

DescribeFeatureService

Describes a single feature in a loaded dataset. Dispatches to a per-spec strategy (EncDotNet.S100.Datasets.Pipelines.Spec.ISpecFeatureDescriber); specs without an end-to-end implementation in this PR return SpecNotSupportedForTool.

FeatureCatalogueNotAvailable

No bundled Feature Catalogue is available for the requested spec.

FeatureNotFound

The named feature is not present in the named dataset.

FeatureReference

A cross-reference from one feature to another, projected from the underlying xlink:href attribute.

FeatureTypeNotFound

The named feature type is not present in the spec's Feature Catalogue.

GeometryInvalid

A supplied geometry is structurally invalid (e.g. an unclosed polygon ring, a polyline with fewer than two vertices, a bounding box whose north edge is south of its south edge, or an antimeridian-crossing bounding box where west > east). Distinguished from InvalidArgument in that a single scalar is well-formed but the composite shape is not.

HostNotReady

A host capability required by a mutating tool is not yet initialised (e.g. the render surface or the dataset loader). The renderer-neutral analog of a host's internal "not ready" state, surfaced to callers so they can retry once the host has finished starting up.

IdentifyFeaturesRequest

Request payload for IdentifyFeaturesService.

IdentifyFeaturesResult

Result of IdentifyFeaturesService.

IdentifyFeaturesService

Identifies the vector features at a geographic point — the ECDIS cursor-pick interaction — ranked by drawing priority where the dataset was portrayed (S-98 15.1), then most-specific first.

IdentifyMatch

A single feature picked at the query point by IdentifyFeaturesService, in pick-report order.

InvalidArgument

A tool argument failed validation (e.g. latitude or longitude outside the valid WGS-84 range). The Parameter names the request property that was rejected and Reason describes why.

NoDataAtPoint

The grid cell at the resolved (row, col) and time step carries the spec-defined no-data fill value. The cell index and time step are surfaced in the message so callers can correlate with the source grid.

NoDatasetCoversPoint

No loaded dataset of the requested spec covers the supplied lat/lon.

NotSupportedYet

The tool understands the requested spec but cannot yet handle this specific shape of dataset (e.g. S-104 data coding format other than 2). Distinguished from SpecNotSupportedForTool in that the spec itself is supported — only this particular variant isn't yet.

OutOfBounds

The requested point falls outside the spatial bounds of every loaded dataset of the requested spec. Distinguished from NoDatasetCoversPoint in cases where no dataset of the requested spec is loaded at all — callers may want to retry once a dataset is loaded — by carrying the dataset spec.

ReferencedText

The resolved content of an external text file referenced by a feature's fileReference attribute (S-101 Feature Catalogue, aliases TXTDSC / NTXTDS) — the headless counterpart of the viewer's referenced-text cards.

SampleCoverageRequest

Request payload for SampleCoverageService.

SampleCoverageResult

Result of SampleCoverageService.

SampleCoverageService

Samples a coverage product at a single lat/lon, returning the nearest grid cell's (or station's) value. Any product whose catalog payload is an ICoverageSampler is supported: S-102 (depth + uncertainty), S-104 (water level height + trend, nearest time step) and S-111 (surface current speed + direction, nearest time step) today.

SampleTimeStatus

Where a requested instant fell relative to the sampled dataset's time range, as reported by CoverageSampling and the sample_coverage tool's timeStatus.

SampledField

One sampled value with its quantity and unit.

SampledValue

Discriminated payload of a coverage sample, returned by an ICoverageSampler and by the sample_coverage tool.

SpecNotSupportedForTool

The tool does not (yet) support the requested spec.

SurfaceCurrentSample

S-111 surface current sample at the nearest grid cell and time step.

SurfaceCurrentStationSample

S-111 surface current sample read from a dcf8 ("time series at fixed stations") dataset — picks the nearest station to the requested position and the nearest time step within that station's series (S-111 Edition 2.0.0 §10.2.3 / §10.2.7).

TimeOutOfRange

The requested time lies outside the time range of every dataset that covers the point, so no value can be sampled. Raised for a single instant outside every candidate's range (unless the caller opted into nearest-step sampling), and for a TimeQuery Range or Series window that does not overlap any candidate's data at all. The details name the candidate whose range comes closest and list every candidate's range, so the caller can re-ask deliberately or tell the user the data doesn't reach that far.

TimedSampledValue

A single entry in a Series: the dataset's actual time-step instant alongside the sampled value at the requested cell.

ToolError

Base type for typed tool errors.

ToolResult<T>

Discriminated union over a successful tool result of type T and a typed ToolError.

ToolResult<T>.ErrResult

Failed variant.

ToolResult<T>.OkResult

Successful variant.

WaterLevelSample

S-104 water level sample at the nearest grid cell and time step.

WaterLevelStationSample

S-104 water level sample read from a dcf8 ("time series at fixed stations") dataset — picks the nearest station to the requested position and the nearest time step within that station's series.

Structs

CoverageStepRequest

A step to read in a windowed query.

CoverageStepWindow

The first and last sample times of a site, with the tolerance (one time-step interval) within which a request beyond either end still counts as in range.

Enums

CoverageSiteKind

The kind of place a CoverageSampleSite is.

TimeOutOfRangePolicy

How SampleCoverageService treats a single requested instant that falls outside the time range of every dataset covering the point.