Class WeatherSelection

Namespace

EncDotNet.S100.Collections.Weather

Assembly

EncDotNet.S100.Collections.dll

What a WeatherFeedSource includes (#1075): which of its service's parameters or datasets, which forecast hours, and where.

public sealed record WeatherSelection : IEquatable<WeatherSelection>

Inheritance

object

WeatherSelection

Implements

IEquatable<WeatherSelection>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WeatherSelection(IReadOnlyList<string>?, IReadOnlyList<int>?, GeoBounds?, IReadOnlyList<string>?, IReadOnlyList<string>?)

What a WeatherFeedSource includes (#1075): which of its service's parameters or datasets, which forecast hours, and where.

public WeatherSelection(IReadOnlyList<string>? Parameters = null, IReadOnlyList<int>? Hours = null, GeoBounds? Area = null, IReadOnlyList<string>? Zones = null, IReadOnlyList<string>? Datasets = null)

Parameters

Parameters IReadOnlyList<string>

For a GRIB2 service, the chosen parameters' IndexMatch keys (:HTSGW:surface:); empty for none chosen, which means the service's defaults.

Hours IReadOnlyList<int>

For a model service, the forecast hours (0, 3, 6 …); empty means the service's defaults.

Area GeoBounds?

The area: the GRIB filter and ERDDAP cut to it, alerts are those of its marine zones; null for the whole grid (AWS) or every marine zone (alerts).

Zones IReadOnlyList<string>

For alerts, the NWS marine zone codes in the area (ANZ535); empty to ask by area.

Datasets IReadOnlyList<string>

For ERDDAP, the chosen dataset ids; empty means the service's defaults.

Properties

Area

The area: the GRIB filter and ERDDAP cut to it, alerts are those of its marine zones; null for the whole grid (AWS) or every marine zone (alerts).

public GeoBounds? Area { get; init; }

Property Value

GeoBounds?

Datasets

For ERDDAP, the chosen dataset ids.

public IReadOnlyList<string> Datasets { get; init; }

Property Value

IReadOnlyList<string>

Hours

The chosen forecast hours.

public IReadOnlyList<int> Hours { get; init; }

Property Value

IReadOnlyList<int>

Parameters

The chosen parameters' .idx keys.

public IReadOnlyList<string> Parameters { get; init; }

Property Value

IReadOnlyList<string>

Zones

For alerts, the marine zones of the area.

public IReadOnlyList<string> Zones { get; init; }

Property Value

IReadOnlyList<string>

Methods

DatasetsOf(WeatherService)

The datasets this selection includes from service: the chosen ones, else its defaults (else all).

public IReadOnlyList<WeatherServiceDataset> DatasetsOf(WeatherService service)

Parameters

service WeatherService

Returns

IReadOnlyList<WeatherServiceDataset>

HoursOf(WeatherService)

The forecast hours this selection includes: the chosen ones the service offers, else up to its default hour.

public IReadOnlyList<int> HoursOf(WeatherService service)

Parameters

service WeatherService

Returns

IReadOnlyList<int>

ParametersOf(WeatherService)

The parameters this selection includes from service: the chosen ones, else its defaults (else all).

public IReadOnlyList<WeatherServiceParameter> ParametersOf(WeatherService service)

Parameters

service WeatherService

Returns

IReadOnlyList<WeatherServiceParameter>