Class CoverageFieldsSample

Namespace

EncDotNet.S100.Datasets.Pipelines.Query

Assembly

EncDotNet.S100.Core.dll

The generic sample shape: a list of SampledFields plus where and when they were read. Returned by a product that has no typed shape of its own, so its values reach MCP callers with no tool changes. Written with the JSON $kind "fields".

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

Inheritance

object

SampledValue

CoverageFieldsSample

Implements

IEquatable<SampledValue>

IEquatable<CoverageFieldsSample>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CoverageFieldsSample(IReadOnlyList<SampledField>, DateTime?, DateTimeOffset?, int?, int?, double?, double?, string?, double?, double?, double?)

The generic sample shape: a list of SampledFields plus where and when they were read. Returned by a product that has no typed shape of its own, so its values reach MCP callers with no tool changes. Written with the JSON $kind "fields".

public CoverageFieldsSample(IReadOnlyList<SampledField> Fields, DateTime? SampleTime = null, DateTimeOffset? RequestedTime = null, int? Row = null, int? Column = null, double? CellCentreLatitude = null, double? CellCentreLongitude = null, string? StationId = null, double? StationDistanceMetres = null, double? StationLatitude = null, double? StationLongitude = null)

Parameters

Fields IReadOnlyList<SampledField>

The sampled values with their quantities and units.

SampleTime DateTime?

UTC instant of the time step read; null for a product with no time dimension.

RequestedTime DateTimeOffset?

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

Row int?

Zero-based row of the grid cell read; null for a station.

Column int?

Zero-based column of the grid cell read; null for a station.

CellCentreLatitude double?

Latitude of the cell centre read; null for a station.

CellCentreLongitude double?

Longitude of the cell centre read; null for a station.

StationId string

Identifier of the station read; null for a grid.

StationDistanceMetres double?

Great-circle distance from the requested point to the station; null for a grid.

StationLatitude double?

Latitude of the station; null for a grid.

StationLongitude double?

Longitude of the station; null for a grid.

Properties

CellCentreLatitude

Latitude of the cell centre read; null for a station.

public double? CellCentreLatitude { get; init; }

Property Value

double?

CellCentreLongitude

Longitude of the cell centre read; null for a station.

public double? CellCentreLongitude { get; init; }

Property Value

double?

Column

Zero-based column of the grid cell read; null for a station.

public int? Column { get; init; }

Property Value

int?

Fields

The sampled values with their quantities and units.

public IReadOnlyList<SampledField> Fields { get; init; }

Property Value

IReadOnlyList<SampledField>

RequestedTime

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

public DateTimeOffset? RequestedTime { get; init; }

Property Value

DateTimeOffset?

Row

Zero-based row of the grid cell read; null for a station.

public int? Row { get; init; }

Property Value

int?

SampleTime

UTC instant of the time step read; null for a product with no time dimension.

public DateTime? SampleTime { get; init; }

Property Value

DateTime?

StationDistanceMetres

Great-circle distance from the requested point to the station; null for a grid.

public double? StationDistanceMetres { get; init; }

Property Value

double?

StationId

Identifier of the station read; null for a grid.

public string? StationId { get; init; }

Property Value

string

StationLatitude

Latitude of the station; null for a grid.

public double? StationLatitude { get; init; }

Property Value

double?

StationLongitude

Longitude of the station; null for a grid.

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>