Class SampleCoverageResult

Namespace

EncDotNet.S100.Datasets.Pipelines.Query

Assembly

EncDotNet.S100.Datasets.Pipelines.dll

Result of SampleCoverageService.

public sealed record SampleCoverageResult : IEquatable<SampleCoverageResult>

Inheritance

object

SampleCoverageResult

Implements

IEquatable<SampleCoverageResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SampleCoverageResult(DatasetId, double, double, SampledValue, IReadOnlyList<TimedSampledValue>?, string?, bool?, DateTimeOffset?, DateTimeOffset?)

Result of SampleCoverageService.

public SampleCoverageResult(DatasetId DatasetId, double Latitude, double Longitude, SampledValue Value, IReadOnlyList<TimedSampledValue>? Series = null, string? TimeStatus = null, bool? Truncated = null, DateTimeOffset? CoveredFrom = null, DateTimeOffset? CoveredTo = null)

Parameters

DatasetId DatasetId

Dataset that produced the sample.

Latitude double

Latitude that was requested, echoed back (decimal degrees, WGS-84).

Longitude double

Longitude that was requested, echoed back (decimal degrees, WGS-84).

Value SampledValue

Typed sample payload; discriminated on the JSON $kind property.

Series IReadOnlyList<TimedSampledValue>

Optional per-time-step series, populated when the request's Times is a Range or Series and the matched dataset is a supported time-varying coverage. Null for single-instant queries, for S-102, and for station-series datasets (which currently honour only single-instant time selection).

TimeStatus string

For a single-instant request on a time-varying product, where the requested time fell relative to the sampled dataset's range — one of the SampleTimeStatus values. before_start / after_end only appear when the request opted into Nearest. Null when no time was requested, for S-102, and for windowed queries.

Truncated bool?

For windowed queries, true when the requested window reaches past the sampled dataset's time range so the series is shorter than requested. Null for single-instant queries.

CoveredFrom DateTimeOffset?

For windowed queries, the start of the requested window clipped to the dataset's range.

CoveredTo DateTimeOffset?

For windowed queries, the end of the requested window clipped to the dataset's range.

Properties

CoveredFrom

For windowed queries, the start of the requested window clipped to the dataset's range.

public DateTimeOffset? CoveredFrom { get; init; }

Property Value

DateTimeOffset?

CoveredTo

For windowed queries, the end of the requested window clipped to the dataset's range.

public DateTimeOffset? CoveredTo { get; init; }

Property Value

DateTimeOffset?

DatasetId

Dataset that produced the sample.

public DatasetId DatasetId { get; init; }

Property Value

DatasetId

Latitude

Latitude that was requested, echoed back (decimal degrees, WGS-84).

public double Latitude { get; init; }

Property Value

double

Longitude

Longitude that was requested, echoed back (decimal degrees, WGS-84).

public double Longitude { get; init; }

Property Value

double

Series

Optional per-time-step series, populated when the request's Times is a Range or Series and the matched dataset is a supported time-varying coverage. Null for single-instant queries, for S-102, and for station-series datasets (which currently honour only single-instant time selection).

public IReadOnlyList<TimedSampledValue>? Series { get; init; }

Property Value

IReadOnlyList<TimedSampledValue>

TimeStatus

For a single-instant request on a time-varying product, where the requested time fell relative to the sampled dataset's range — one of the SampleTimeStatus values. before_start / after_end only appear when the request opted into Nearest. Null when no time was requested, for S-102, and for windowed queries.

public string? TimeStatus { get; init; }

Property Value

string

Truncated

For windowed queries, true when the requested window reaches past the sampled dataset's time range so the series is shorter than requested. Null for single-instant queries.

public bool? Truncated { get; init; }

Property Value

bool?

Value

Typed sample payload; discriminated on the JSON $kind property.

public SampledValue Value { get; init; }

Property Value

SampledValue