Class NoaaEncScope

Namespace

EncDotNet.S100.Collections.Library

Assembly

EncDotNet.S100.Collections.dll

A scope of the NOAA ENC product catalogue: by state, Coast Guard district or region.

public sealed class NoaaEncScope : LibraryCatalogueScope

Inheritance

object

LibraryCatalogueScope

NoaaEncScope

Inherited Members

LibraryCatalogueScope.CatalogUri

LibraryCatalogueScope.CatalogueDate

LibraryCatalogueScope.Choices

LibraryCatalogueScope.IsUnscoped

LibraryCatalogueScope.SelectedCount

LibraryCatalogueScope.IncludeAll

LibraryCatalogueScope.IsEverything

LibraryCatalogueScope.ScopeSummary

LibraryCatalogueScope.CanBuild

LibraryCatalogueScope.Name

LibraryCatalogueScope.Changed

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NoaaEncScope(Uri, Func<Uri, CancellationToken, Task<NoaaEncProductCatalog>>)

Creates a scope of the NOAA catalogue at catalogUri.

public NoaaEncScope(Uri catalogUri, Func<Uri, CancellationToken, Task<NoaaEncProductCatalog>> load)

Parameters

catalogUri Uri

The catalogue's URL.

load Func<Uri, CancellationToken, Task<NoaaEncProductCatalog>>

Reads the catalogue.

Properties

CoastGuardDistricts

The Coast Guard districts in the catalogue.

public IReadOnlyList<LibraryChoice> CoastGuardDistricts { get; }

Property Value

IReadOnlyList<LibraryChoice>

CurrentFilter

The filter for the ticked choices.

public NoaaEncFilter CurrentFilter { get; }

Property Value

NoaaEncFilter

EverythingSummary

"12,345 cells · 1.2 GB" for the whole catalogue.

public override string EverythingSummary { get; }

Property Value

string

Groups

The choice groups, once the catalogue has been read.

public override IReadOnlyList<LibraryChoiceGroup> Groups { get; }

Property Value

IReadOnlyList<LibraryChoiceGroup>

IsLoaded

True once the catalogue has been read.

public override bool IsLoaded { get; }

Property Value

bool

Regions

The regions in the catalogue.

public IReadOnlyList<LibraryChoice> Regions { get; }

Property Value

IReadOnlyList<LibraryChoice>

SelectionSummary

What the ticked choices (or, with none, the whole catalogue) amount to, e.g. "12 cells · 3 MB".

public override string SelectionSummary { get; }

Property Value

string

SingleEntry

The catalogue's only download, when it lists just one (there is nothing to choose); otherwise null.

public override LibraryChoice? SingleEntry { get; }

Property Value

LibraryChoice

States

The states in the catalogue.

public IReadOnlyList<LibraryChoice> States { get; }

Property Value

IReadOnlyList<LibraryChoice>

Methods

Build(Guid, string?)

The source the scope describes.

public override CollectionSource Build(Guid id, string? name)

Parameters

id Guid

The new source's id.

name string

The source's name when everything is included (the catalogue's name); a selection names it after the selection. A manifest source always takes it.

Returns

CollectionSource

DescribeSelection()

Describes the ticked choices ("Alaska, Hawaii"), or null when nothing is ticked.

public override string? DescribeSelection()

Returns

string

LoadAsync(CancellationToken)

Reads the catalogue and creates its choices.

public override Task<string?> LoadAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the read.

Returns

Task<string>

Why the catalogue could not be read, or null when it was.