Class SampleCoverageRequest

Namespace

EncDotNet.S100.Datasets.Pipelines.Query

Assembly

EncDotNet.S100.Datasets.Pipelines.dll

Request payload for SampleCoverageService.

public sealed record SampleCoverageRequest : IEquatable<SampleCoverageRequest>

Inheritance

object

SampleCoverageRequest

Implements

IEquatable<SampleCoverageRequest>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SampleCoverageRequest(SpecRef, double, double, DateTimeOffset?, TimeQuery?, TimeOutOfRangePolicy)

Request payload for SampleCoverageService.

public SampleCoverageRequest(SpecRef Spec, double Latitude, double Longitude, DateTimeOffset? Time = null, TimeQuery? Times = null, TimeOutOfRangePolicy OutOfRange = TimeOutOfRangePolicy.Error)

Parameters

Spec SpecRef

Spec of the coverage to sample: S-102, S-104, S-111, or any product whose catalog payload implements ICoverageSampler.

Latitude double

Sample latitude (decimal degrees, WGS-84).

Longitude double

Sample longitude (decimal degrees, WGS-84).

Time DateTimeOffset?

Optional time selector for time-varying products (S-104, S-111). Ignored for S-102 (which has no time dimension). When null on a time-varying product the first time step of the matched coverage is used. When supplied, the nearest time step of a dataset whose range contains the time is selected; a time outside every covering dataset's range is handled per OutOfRange.

Times TimeQuery

Optional richer temporal query. Takes precedence over Time when supplied. Instant behaves like Time; Range and Series populate Series with a per-step entry. Currently honoured for gridded S-104 and S-111; ignored elsewhere.

OutOfRange TimeOutOfRangePolicy

What to do when a single requested instant lies outside the time range of every dataset covering the point: Error (the default) returns TimeOutOfRange; Nearest samples the nearest step and flags it in TimeStatus. Windowed queries are unaffected.

Properties

Latitude

Sample latitude (decimal degrees, WGS-84).

public double Latitude { get; init; }

Property Value

double

Longitude

Sample longitude (decimal degrees, WGS-84).

public double Longitude { get; init; }

Property Value

double

OutOfRange

What to do when a single requested instant lies outside the time range of every dataset covering the point: Error (the default) returns TimeOutOfRange; Nearest samples the nearest step and flags it in TimeStatus. Windowed queries are unaffected.

public TimeOutOfRangePolicy OutOfRange { get; init; }

Property Value

TimeOutOfRangePolicy

Spec

Spec of the coverage to sample: S-102, S-104, S-111, or any product whose catalog payload implements ICoverageSampler.

public SpecRef Spec { get; init; }

Property Value

SpecRef

Time

Optional time selector for time-varying products (S-104, S-111). Ignored for S-102 (which has no time dimension). When null on a time-varying product the first time step of the matched coverage is used. When supplied, the nearest time step of a dataset whose range contains the time is selected; a time outside every covering dataset's range is handled per OutOfRange.

public DateTimeOffset? Time { get; init; }

Property Value

DateTimeOffset?

Times

Optional richer temporal query. Takes precedence over Time when supplied. Instant behaves like Time; Range and Series populate Series with a per-step entry. Currently honoured for gridded S-104 and S-111; ignored elsewhere.

public TimeQuery? Times { get; init; }

Property Value

TimeQuery