Class SurfaceCurrentStationSample

Namespace

EncDotNet.S100.Datasets.Pipelines.Query

Assembly

EncDotNet.S100.Datasets.Pipelines.dll

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).

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

Inheritance

object

SampledValue

SurfaceCurrentStationSample

Implements

IEquatable<SampledValue>

IEquatable<SurfaceCurrentStationSample>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurfaceCurrentStationSample(string, double, double, double, double, DateTime, DateTimeOffset?, double, double)

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).

public SurfaceCurrentStationSample(string StationId, double StationDistanceMetres, double SpeedMetresPerSecond, double SpeedKnots, double DirectionDegreesTrue, DateTime SampleTime, DateTimeOffset? RequestedTime, double StationLatitude, double StationLongitude)

Parameters

StationId string

Reporting station identifier (S-111 stationIdentification).

StationDistanceMetres double

Great-circle distance from requested point to the station, metres.

SpeedMetresPerSecond double

Speed in metres per second, converted from the encoded knots as kn × 0.514444.

SpeedKnots double

Speed in knots — the unit S-111 encodes surfaceCurrentSpeed in.

DirectionDegreesTrue double

Direction in degrees from true north, clockwise (0..360).

SampleTime DateTime

Actual time step (UTC) selected for this sample.

RequestedTime DateTimeOffset?

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

StationLatitude double

Latitude of the matched station.

StationLongitude double

Longitude of the matched station.

Properties

DirectionDegreesTrue

Direction in degrees from true north, clockwise (0..360).

public double DirectionDegreesTrue { get; init; }

Property Value

double

RequestedTime

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

public DateTimeOffset? RequestedTime { get; init; }

Property Value

DateTimeOffset?

SampleTime

Actual time step (UTC) selected for this sample.

public DateTime SampleTime { get; init; }

Property Value

DateTime

SpeedKnots

Speed in knots — the unit S-111 encodes surfaceCurrentSpeed in.

public double SpeedKnots { get; init; }

Property Value

double

SpeedMetresPerSecond

Speed in metres per second, converted from the encoded knots as kn × 0.514444.

public double SpeedMetresPerSecond { get; init; }

Property Value

double

StationDistanceMetres

Great-circle distance from requested point to the station, metres.

public double StationDistanceMetres { get; init; }

Property Value

double

StationId

Reporting station identifier (S-111 stationIdentification).

public string StationId { get; init; }

Property Value

string

StationLatitude

Latitude of the matched station.

public double StationLatitude { get; init; }

Property Value

double

StationLongitude

Longitude of the matched station.

public double StationLongitude { 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>