Class MapsuiMapTimedDataset

Namespace

EncDotNet.S100.Renderers.Mapsui

Assembly

EncDotNet.S100.Renderers.Mapsui.dll

A registered dataset that has time samples, and the span they cover.

public sealed record MapsuiMapTimedDataset : IEquatable<MapsuiMapTimedDataset>

Inheritance

object

MapsuiMapTimedDataset

Implements

IEquatable<MapsuiMapTimedDataset>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

MapsuiMapTimedDataset(string, DateTime, DateTime)

A registered dataset that has time samples, and the span they cover.

public MapsuiMapTimedDataset(string Name, DateTime First, DateTime Last)

Parameters

Name string

The dataset's name (usually its file name without extension).

First DateTime

Its earliest time sample.

Last DateTime

Its latest time sample.

Properties

Coverage

The windows in which this dataset draws under its product's time policy; outside them it has no data near the clock and hides. Empty when not computed.

public IReadOnlyList<MapsuiMapTimeSegment> Coverage { get; init; }

Property Value

IReadOnlyList<MapsuiMapTimeSegment>

DatasetId

The session's id for the dataset (the value of its MapDatasetId), when known.

public string? DatasetId { get; init; }

Property Value

string

First

Its earliest time sample.

public DateTime First { get; init; }

Property Value

DateTime

ForecastRun

The model run the dataset belongs to, as its processor reports it (ITimeAwareDatasetProcessor.ForecastRun), or null when it is not a forecast run.

public DatasetForecastRun? ForecastRun { get; init; }

Property Value

DatasetForecastRun

IssueTime

When the producer issued the dataset (UTC), from its data, when known; for a forecast, usually some time after its model run (#720).

public DateTime? IssueTime { get; init; }

Property Value

DateTime?

Last

Its latest time sample.

public DateTime Last { get; init; }

Property Value

DateTime

Name

The dataset's name (usually its file name without extension).

public string Name { get; init; }

Property Value

string

ProductSpec

The dataset's product specification (e.g. S-111), when known.

public string? ProductSpec { get; init; }

Property Value

string

Samples

The dataset's own time samples, ascending; empty when not computed.

public IReadOnlyList<DateTime> Samples { get; init; }

Property Value

IReadOnlyList<DateTime>

Selection

How the dataset picks the sample it draws.

public MapsuiTimeSelectionKind Selection { get; init; }

Property Value

MapsuiTimeSelectionKind

Tolerance

How far from the clock a sample may be and still be drawn.

public TimeSpan Tolerance { get; init; }

Property Value

TimeSpan

Methods

Covers(DateTime)

True when the dataset has data within its tolerance of time.

public bool Covers(DateTime time)

Parameters

time DateTime

The clock value.

Returns

bool

Equals(MapsuiMapTimedDataset?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(MapsuiMapTimedDataset? other)

Parameters

other MapsuiMapTimedDataset

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

SampleAt(DateTime)

The sample the dataset draws at time under its time rule, or null when it has no data near that time and hides.

public DateTime? SampleAt(DateTime time)

Parameters

time DateTime

The clock value.

Returns

DateTime?