Interface IWaterLevelSeries

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

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

public interface IWaterLevelSeries

Properties

End

The last time step (UTC).

DateTime End { get; }

Property Value

DateTime

Source

Where the series comes from.

WaterLevelSourceInfo Source { get; }

Property Value

WaterLevelSourceInfo

Start

The first time step (UTC).

DateTime Start { get; }

Property Value

DateTime

Methods

StepsWithin(DateTime, DateTime)

The series' own time steps that fall within [start, end], in order. WaterLevelPeriodMinimum reads the series at each of them.

IReadOnlyList<DateTime> StepsWithin(DateTime start, DateTime end)

Parameters

start DateTime

The start of the period (UTC), inclusive.

end DateTime

The end of the period (UTC), inclusive.

Returns

IReadOnlyList<DateTime>

The step times, ascending.

ValueAt(DateTime)

The water level at utc, interpolated linearly between the bracketing steps, or null when the value is NoData (a masked cell). Times outside Start…End are the caller's to reject; implementations may clamp.

WaterLevelReading? ValueAt(DateTime utc)

Parameters

utc DateTime

The time (UTC).

Returns

WaterLevelReading?

The reading, or null.