Class S111DatasetReader

Namespace

EncDotNet.S100.Datasets.S111

Assembly

EncDotNet.S100.Datasets.S111.dll

Reads an S-111 Surface Currents dataset from an HDF5 file via the IHdf5File abstraction. Supports data coding format 2 (regular grid), data coding format 3 (ungeorectified grid with explicit per-node positioning; S-100 Part 10c §10.2.1), and data coding format 8 (time series at fixed stations; S-111 Edition 2.0.0 §10.2.3 / §10.2.7).

public static class S111DatasetReader

Inheritance

object

S111DatasetReader

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Read(IHdf5File)

Reads an S111Dataset from the given HDF5 file. Throws S100DatasetNotSupportedException if the dataset is not dcf2 (regularly-gridded). Use ReadAny(IHdf5File) to handle dcf1, dcf2, dcf3, and dcf8.

public static S111Dataset Read(IHdf5File file)

Parameters

file IHdf5File

Returns

S111Dataset

ReadAny(IHdf5File)

Reads either a dcf2 S111Dataset or a dcf1/dcf3/dcf8 S111StationSeriesDataset from the given HDF5 file, dispatching on the /SurfaceCurrent/dataCodingFormat attribute (S-100 Part 10c §10.2.1). Other data coding formats raise S100DatasetNotSupportedException.

public static S111DatasetData ReadAny(IHdf5File file)

Parameters

file IHdf5File

Returns

S111DatasetData

ReadAny(IHdf5File, S111ReadOptions?)

Reads either a dcf2 S111Dataset or a dcf1/dcf3/dcf8 S111StationSeriesDataset from the given HDF5 file, dispatching on the /SurfaceCurrent/dataCodingFormat attribute (S-100 Part 10c §10.2.1). Other data coding formats raise S100DatasetNotSupportedException.

public static S111DatasetData ReadAny(IHdf5File file, S111ReadOptions? options)

Parameters

file IHdf5File

The HDF5 file to read.

options S111ReadOptions

Optional read options. When DeferValueReads is set, dcf2 (regular-grid) per-time-step values datasets are read lazily on first access rather than up front; the caller must keep file open for the lifetime of the returned dataset. dcf1/dcf3/dcf8 (station-series) datasets always materialize fully and ignore this flag.

Returns

S111DatasetData

ReadMetadata(IHdf5File)

Reads only the lightweight DatasetMetadata for the S-111 dataset — its declared specification, horizontal CRS, geographic extent, and temporal coverage — for phased / deferred loading (issue #460).

public static DatasetMetadata ReadMetadata(IHdf5File file)

Parameters

file IHdf5File

Returns

DatasetMetadata

Remarks

For data coding format 2 (regularly-gridded) the extent is the union of the SurfaceCurrent.NN grid footprints and the time coverage spans the timePoint attributes of every Group_NNN step, read without touching the per-step values arrays. For data coding formats 3 (ungeorectified grid) and 8 (time series at fixed stations) the comparatively small station series is read in full and the extent / time span are derived from the station positions and record windows.