Class SurfaceCurrentSample

Namespace

EncDotNet.S100.Datasets.Pipelines.Query

Assembly

EncDotNet.S100.Datasets.Pipelines.dll

S-111 surface current sample at the nearest grid cell and time step.

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

Inheritance

object

SampledValue

SurfaceCurrentSample

Implements

IEquatable<SampledValue>

IEquatable<SurfaceCurrentSample>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurfaceCurrentSample(double, double, double, DateTime, DateTimeOffset?, int, int, double, double)

S-111 surface current sample at the nearest grid cell and time step.

public SurfaceCurrentSample(double SpeedMetresPerSecond, double SpeedKnots, double DirectionDegreesTrue, DateTime SampleTime, DateTimeOffset? RequestedTime, int Row, int Column, double CellCentreLatitude, double CellCentreLongitude)

Parameters

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

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

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?

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

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

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>