Class KnownCatalogueSource

Namespace

EncDotNet.S100.Collections.KnownSources

Assembly

EncDotNet.S100.Collections.dll

One online chart catalogue in the curated list of known sources (issue #670): where it is, who publishes it, and what it provides.

public sealed record KnownCatalogueSource : IEquatable<KnownCatalogueSource>

Inheritance

object

KnownCatalogueSource

Implements

IEquatable<KnownCatalogueSource>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

KnownCatalogueSource(string, string, string, IReadOnlyList<string>, KnownCatalogueFormat, Uri, Uri?, KnownCatalogueCoverage, bool, bool, string?, string?, bool, IReadOnlyList<ForecastModel>?, bool, WeatherService?, string?, string?)

One online chart catalogue in the curated list of known sources (issue #670): where it is, who publishes it, and what it provides.

public KnownCatalogueSource(string Id, string Name, string Provider, IReadOnlyList<string> Region, KnownCatalogueFormat Format, Uri CatalogUri, Uri? Homepage, KnownCatalogueCoverage Coverage, bool Editions, bool Sizes, string? Note = null, string? Product = null, bool NotForNavigation = false, IReadOnlyList<ForecastModel>? Models = null, bool Pilot = false, WeatherService? Weather = null, string? Licence = null, string? Attribution = null)

Parameters

Id string

A stable identifier (e.g. noaa-enc).

Name string

The display name.

Provider string

Who publishes the catalogue.

Region IReadOnlyList<string>

Where it applies, broadest first (e.g. North America › United States).

Format KnownCatalogueFormat

The catalogue format.

CatalogUri Uri

The catalogue's URL.

Homepage Uri

The provider's page for the data (terms, notices), if any.

Coverage KnownCatalogueCoverage

What coverage the catalogue publishes.

Editions bool

True when the catalogue lists editions and updates (so UPDATE can be detected).

Sizes bool

True when the catalogue lists download sizes.

Note string

A short description shown with the entry, if any.

Product string

The one product specification the catalogue publishes (e.g. S-102), if it says.

NotForNavigation bool

True when the provider marks all of the catalogue's data as not for navigation.

Models IReadOnlyList<ForecastModel>

For a forecast feed, its models (curated: names, cadence and forecast horizon); otherwise empty.

Pilot bool

True for a pilot service, which may cover little and lapse (shown with a "Pilot" chip).

Weather WeatherService

For a weather service, what it offers and how it is asked; otherwise null.

Licence string

The data's licence ("Public domain", "CC BY 4.0"), if the list says.

Attribution string

The attribution the provider asks for, if any; carried onto loaded layers and pick reports.

Properties

Attribution

The attribution the provider asks for, if any; carried onto loaded layers and pick reports.

public string? Attribution { get; init; }

Property Value

string

CatalogUri

The catalogue's URL.

public Uri CatalogUri { get; init; }

Property Value

Uri

Coverage

What coverage the catalogue publishes.

public KnownCatalogueCoverage Coverage { get; init; }

Property Value

KnownCatalogueCoverage

Editions

True when the catalogue lists editions and updates (so UPDATE can be detected).

public bool Editions { get; init; }

Property Value

bool

Format

The catalogue format.

public KnownCatalogueFormat Format { get; init; }

Property Value

KnownCatalogueFormat

Homepage

The provider's page for the data (terms, notices), if any.

public Uri? Homepage { get; init; }

Property Value

Uri

Id

A stable identifier (e.g. noaa-enc).

public string Id { get; init; }

Property Value

string

Licence

The data's licence ("Public domain", "CC BY 4.0"), if the list says.

public string? Licence { get; init; }

Property Value

string

Models

For a forecast feed, its models; otherwise empty.

public IReadOnlyList<ForecastModel> Models { get; init; }

Property Value

IReadOnlyList<ForecastModel>

Name

The display name.

public string Name { get; init; }

Property Value

string

NotForNavigation

True when the provider marks all of the catalogue's data as not for navigation.

public bool NotForNavigation { get; init; }

Property Value

bool

Note

A short description shown with the entry, if any.

public string? Note { get; init; }

Property Value

string

Pilot

True for a pilot service, which may cover little and lapse (shown with a "Pilot" chip).

public bool Pilot { get; init; }

Property Value

bool

Product

The one product specification the catalogue publishes (e.g. S-102), if it says.

public string? Product { get; init; }

Property Value

string

Provider

Who publishes the catalogue.

public string Provider { get; init; }

Property Value

string

Region

Where it applies, broadest first (e.g. North America › United States).

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

Property Value

IReadOnlyList<string>

ServiceMrn

For a SECOM service from a service registry, its MRN (e.g. urn:mrn:mcp:service:mcc:khra:s-124), which says which MCP instance it accepts identities from (#883); otherwise null.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? ServiceMrn { get; init; }

Property Value

string

Sizes

True when the catalogue lists download sizes.

public bool Sizes { get; init; }

Property Value

bool

Weather

For a weather service, what it offers and how it is asked; otherwise null.

public WeatherService? Weather { get; init; }

Property Value

WeatherService