Class TimeQuery.Series

Namespace

EncDotNet.S100.Datasets.Pipelines.Time

Assembly

EncDotNet.S100.Datasets.Pipelines.dll

Stepped enumeration from From through To inclusive, separated by Step.

public sealed record TimeQuery.Series : TimeQuery, IEquatable<TimeQuery>, IEquatable<TimeQuery.Series>

Inheritance

object

TimeQuery

TimeQuery.Series

Implements

IEquatable<TimeQuery>

IEquatable<TimeQuery.Series>

Inherited Members

TimeQuery.MaxSeriesCount

TimeQuery.At(DateTimeOffset)

TimeQuery.Between(DateTimeOffset, DateTimeOffset)

TimeQuery.Every(DateTimeOffset, DateTimeOffset, TimeSpan)

TimeQuery.GetWindow()

TimeQuery.Overlaps(DateTimeOffset?, DateTimeOffset?)

TimeQuery.Contains(DateTimeOffset)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Series(DateTimeOffset, DateTimeOffset, TimeSpan)

Stepped enumeration from From through To inclusive, separated by Step.

public Series(DateTimeOffset From, DateTimeOffset To, TimeSpan Step)

Parameters

From DateTimeOffset

First instant in the series.

To DateTimeOffset

Last instant the series may not exceed.

Step TimeSpan

Cadence between successive instants; must be > Zero.

Properties

EstimatedCount

Number of instants that Enumerate() would produce, without materialising them. Always at least 1 when From == To.

public int EstimatedCount { get; }

Property Value

int

From

First instant in the series.

public DateTimeOffset From { get; init; }

Property Value

DateTimeOffset

Step

Cadence between successive instants; must be > Zero.

public TimeSpan Step { get; init; }

Property Value

TimeSpan

To

Last instant the series may not exceed.

public DateTimeOffset To { get; init; }

Property Value

DateTimeOffset

Methods

Enumerate()

Materialises the series as an immutable array. Throws InvalidOperationException if the count would exceed MaxSeriesCount.

public IReadOnlyList<DateTimeOffset> Enumerate()

Returns

IReadOnlyList<DateTimeOffset>