Class TimeOutOfRange

Namespace

EncDotNet.S100.Datasets.Pipelines.Query

Assembly

EncDotNet.S100.Datasets.Pipelines.dll

The requested time lies outside the time range of every dataset that covers the point, so no value can be sampled. Raised for a single instant outside every candidate's range (unless the caller opted into nearest-step sampling), and for a TimeQuery Range or Series window that does not overlap any candidate's data at all. The details name the candidate whose range comes closest and list every candidate's range, so the caller can re-ask deliberately or tell the user the data doesn't reach that far.

public sealed record TimeOutOfRange : ToolError, IEquatable<ToolError>, IEquatable<TimeOutOfRange>

Inheritance

object

ToolError

TimeOutOfRange

Implements

IEquatable<ToolError>

IEquatable<TimeOutOfRange>

Inherited Members

ToolError.Code

ToolError.Message

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TimeOutOfRange(string, DateTimeOffset?, DateTimeOffset, DateTimeOffset, DatasetId, DateTimeOffset, DateTimeOffset, DateTimeOffset, DateTimeOffset?, IReadOnlyList<DatasetTimeRange>)

The requested time lies outside the time range of every dataset that covers the point, so no value can be sampled. Raised for a single instant outside every candidate's range (unless the caller opted into nearest-step sampling), and for a TimeQuery Range or Series window that does not overlap any candidate's data at all. The details name the candidate whose range comes closest and list every candidate's range, so the caller can re-ask deliberately or tell the user the data doesn't reach that far.

public TimeOutOfRange(string Parameter, DateTimeOffset? RequestedTime, DateTimeOffset WindowStart, DateTimeOffset WindowEnd, DatasetId DatasetId, DateTimeOffset ValidFrom, DateTimeOffset ValidTo, DateTimeOffset NearestStep, DateTimeOffset? Run, IReadOnlyList<DatasetTimeRange> Candidates)

Parameters

Parameter string

Name of the request parameter that carried the out-of-range time (time or times).

RequestedTime DateTimeOffset?

The requested instant (UTC ISO-8601); null for windowed queries.

WindowStart DateTimeOffset

Inclusive start of the requested window (UTC ISO-8601); equals RequestedTime for an instant.

WindowEnd DateTimeOffset

Inclusive end of the requested window (UTC ISO-8601); equals RequestedTime for an instant.

DatasetId DatasetId

The candidate dataset whose range lies nearest the requested time.

ValidFrom DateTimeOffset

First time step of that dataset (UTC ISO-8601).

ValidTo DateTimeOffset

Last time step of that dataset (UTC ISO-8601).

NearestStep DateTimeOffset

The available step closest to the request (UTC ISO-8601).

Run DateTimeOffset?

Issue time of that dataset (its model run), when the dataset declares one.

Candidates IReadOnlyList<DatasetTimeRange>

Every dataset covering the point, with its time range.

Properties

Candidates

Every dataset covering the point, with its time range.

public IReadOnlyList<DatasetTimeRange> Candidates { get; init; }

Property Value

IReadOnlyList<DatasetTimeRange>

DatasetId

The candidate dataset whose range lies nearest the requested time.

public DatasetId DatasetId { get; init; }

Property Value

DatasetId

NearestStep

The available step closest to the request (UTC ISO-8601).

public DateTimeOffset NearestStep { get; init; }

Property Value

DateTimeOffset

Parameter

Name of the request parameter that carried the out-of-range time (time or times).

public string Parameter { get; init; }

Property Value

string

RequestedTime

The requested instant (UTC ISO-8601); null for windowed queries.

public DateTimeOffset? RequestedTime { get; init; }

Property Value

DateTimeOffset?

Run

Issue time of that dataset (its model run), when the dataset declares one.

public DateTimeOffset? Run { get; init; }

Property Value

DateTimeOffset?

ValidFrom

First time step of that dataset (UTC ISO-8601).

public DateTimeOffset ValidFrom { get; init; }

Property Value

DateTimeOffset

ValidTo

Last time step of that dataset (UTC ISO-8601).

public DateTimeOffset ValidTo { get; init; }

Property Value

DateTimeOffset

WindowEnd

Inclusive end of the requested window (UTC ISO-8601); equals RequestedTime for an instant.

public DateTimeOffset WindowEnd { get; init; }

Property Value

DateTimeOffset

WindowStart

Inclusive start of the requested window (UTC ISO-8601); equals RequestedTime for an instant.

public DateTimeOffset WindowStart { get; init; }

Property Value

DateTimeOffset