Class S111StationSeriesDataset

Namespace

EncDotNet.S100.Datasets.S111

Assembly

EncDotNet.S100.Datasets.S111.dll

Root data model for an S-111 Surface Currents dataset encoded as time-major fixed stations (DCF1), an ungeorectified grid (DCF3), or station-major fixed stations (DCF8), as defined by S-111 Edition 2.0.0 §10.2.2.6–10.2.2.9.

public sealed class S111StationSeriesDataset

Inheritance

object

S111StationSeriesDataset

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Both DCF 3 and DCF 8 are represented as a collection of SurfaceCurrentStation objects — each node in a DCF 3 ungeorectified grid maps to a "station" with its values gathered across time steps. The two shapes share the S-111 Feature Catalogue's SurfaceCurrent feature; the distinction is encoding, not taxonomy.

Properties

AxisOrder

The outcome of the dataset-level axis-order check on the station positions (issue #650), or null when there are no positions. When it is Swapped the reader has already swapped every station's latitude and longitude.

public AxisOrderAssessment? AxisOrder { get; init; }

Property Value

AxisOrderAssessment

DataCodingFormat

Data coding format — 1 for time-major fixed stations, 3 for ungeorectified grid, or 8 for station-major fixed stations (S-111 Edition 2.0.0 Table 10-5).

public int DataCodingFormat { get; init; }

Property Value

int

DeclaredProductSpecification

The raw productSpecification string declared on the dataset root (e.g. "INT.IHO.S-111.2.0.0"), or null when the attribute is absent. S-100 Part 10c §10.2.1. Carried on the dataset itself so consumers holding only the dataset (coverage sources, catalog payloads) can report its declared edition.

public string? DeclaredProductSpecification { get; init; }

Property Value

string

Epoch

Epoch of the coordinate reference system (e.g. "G1762").

public string? Epoch { get; init; }

Property Value

string

GeographicIdentifier

A geographic description of the dataset coverage area.

public string? GeographicIdentifier { get; init; }

Property Value

string

HorizontalCRS

EPSG code of the horizontal coordinate reference system.

public int? HorizontalCRS { get; init; }

Property Value

int?

IssueDate

Issue date of the dataset (ISO 8601).

public string? IssueDate { get; init; }

Property Value

string

IssueTime

Issue time of the dataset as written (issueTime, e.g. 135227Z or 13:45:43.63); S100IssueTime combines it with IssueDate.

public string? IssueTime { get; init; }

Property Value

string

MaxTime

Latest sample timestamp across all stations, or null when Stations is empty.

public DateTime? MaxTime { get; init; }

Property Value

DateTime?

Metadata

Reference to an associated metadata file.

public string? Metadata { get; init; }

Property Value

string

MinTime

Earliest sample timestamp across all stations, or null when Stations is empty.

public DateTime? MinTime { get; init; }

Property Value

DateTime?

Stations

Time-series stations contained in the dataset.

public required IReadOnlyList<SurfaceCurrentStation> Stations { get; init; }

Property Value

IReadOnlyList<SurfaceCurrentStation>

SurfaceCurrentDepth

The surfaceCurrentDepth root attribute, in metres, interpreted per depthTypeIndex: a height on an upward axis relative to the reference level (so a level below the sea surface is negative, e.g. -4.5), or the positive thickness of a layer average.

public float? SurfaceCurrentDepth { get; init; }

Property Value

float?

TypeOfCurrentData

Type of current data (e.g. 6 = forecast model output). See S-111 Edition 2.0.0 §10.2 for the enumeration.

public int? TypeOfCurrentData { get; init; }

Property Value

int?