Class WaterLevelSample

Namespace

EncDotNet.S100.Datasets.Pipelines.Query

Assembly

EncDotNet.S100.Datasets.Pipelines.dll

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

public sealed record WaterLevelSample : SampledValue, IEquatable<SampledValue>, IEquatable<WaterLevelSample>

Inheritance

object

SampledValue

WaterLevelSample

Implements

IEquatable<SampledValue>

IEquatable<WaterLevelSample>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WaterLevelSample(double, string, DateTime, DateTimeOffset?, int, int, double, double)

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

public WaterLevelSample(double WaterLevelHeight, string Trend, DateTime SampleTime, DateTimeOffset? RequestedTime, int Row, int Column, double CellCentreLatitude, double CellCentreLongitude)

Parameters

WaterLevelHeight double

Water level height in metres relative to the vertical datum.

Trend string

Decoded S-104 trend (per S-104 §10.2.2: 0=unknown, 1=decreasing, 2=increasing, 3=steady). When the raw value falls outside the spec-defined set the raw integer is surfaced as the string instead.

SampleTime DateTime

The actual time step (UTC) selected for this sample.

RequestedTime DateTimeOffset?

The time the caller asked for, or null if unspecified.

Row int

Row index of the resolved cell in the source grid (0-based).

Column int

Column index of the resolved cell in the source grid (0-based).

CellCentreLatitude double

Latitude of the resolved cell centre.

CellCentreLongitude double

Longitude of the resolved cell centre.

Properties

CellCentreLatitude

Latitude of the resolved cell centre.

public double CellCentreLatitude { get; init; }

Property Value

double

CellCentreLongitude

Longitude of the resolved cell centre.

public double CellCentreLongitude { get; init; }

Property Value

double

Column

Column index of the resolved cell in the source grid (0-based).

public int Column { get; init; }

Property Value

int

RequestedTime

The time the caller asked for, or null if unspecified.

public DateTimeOffset? RequestedTime { get; init; }

Property Value

DateTimeOffset?

Row

Row index of the resolved cell in the source grid (0-based).

public int Row { get; init; }

Property Value

int

SampleTime

The actual time step (UTC) selected for this sample.

public DateTime SampleTime { get; init; }

Property Value

DateTime

Trend

Decoded S-104 trend (per S-104 §10.2.2: 0=unknown, 1=decreasing, 2=increasing, 3=steady). When the raw value falls outside the spec-defined set the raw integer is surfaced as the string instead.

public string Trend { get; init; }

Property Value

string

WaterLevelHeight

Water level height in metres relative to the vertical datum.

public double WaterLevelHeight { get; init; }

Property Value

double

Methods

GetFields()

The sampled values with their quantities and units, in a fixed order per product. A method rather than a property so the typed variants' JSON is unchanged.

public override IReadOnlyList<SampledField> GetFields()

Returns

IReadOnlyList<SampledField>