Class NoaaEncFacets

Namespace

EncDotNet.S100.Collections.Noaa

Assembly

EncDotNet.S100.Collections.dll

The states, Coast Guard districts and regions present in a NOAA ENC product catalogue, with cell counts and download sizes, for choosing a NoaaEncFilter.

public sealed record NoaaEncFacets : IEquatable<NoaaEncFacets>

Inheritance

object

NoaaEncFacets

Implements

IEquatable<NoaaEncFacets>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NoaaEncFacets(IReadOnlyList<CatalogFacetValue>, IReadOnlyList<CatalogFacetValue>, IReadOnlyList<CatalogFacetValue>)

The states, Coast Guard districts and regions present in a NOAA ENC product catalogue, with cell counts and download sizes, for choosing a NoaaEncFilter.

public NoaaEncFacets(IReadOnlyList<CatalogFacetValue> States, IReadOnlyList<CatalogFacetValue> CoastGuardDistricts, IReadOnlyList<CatalogFacetValue> Regions)

Parameters

States IReadOnlyList<CatalogFacetValue>

Per-state counts, by state code.

CoastGuardDistricts IReadOnlyList<CatalogFacetValue>

Per-district counts, by district number.

Regions IReadOnlyList<CatalogFacetValue>

Per-region counts, by region number.

Properties

CoastGuardDistricts

Per-district counts, by district number.

public IReadOnlyList<CatalogFacetValue> CoastGuardDistricts { get; init; }

Property Value

IReadOnlyList<CatalogFacetValue>

Regions

Per-region counts, by region number.

public IReadOnlyList<CatalogFacetValue> Regions { get; init; }

Property Value

IReadOnlyList<CatalogFacetValue>

States

Per-state counts, by state code.

public IReadOnlyList<CatalogFacetValue> States { get; init; }

Property Value

IReadOnlyList<CatalogFacetValue>

Methods

Compute(NoaaEncProductCatalog, bool)

Computes the facets of catalog, counting only cells that are not cancelled unless includeCancelled is set.

public static NoaaEncFacets Compute(NoaaEncProductCatalog catalog, bool includeCancelled = false)

Parameters

catalog NoaaEncProductCatalog

includeCancelled bool

Returns

NoaaEncFacets

Summarize(NoaaEncProductCatalog, NoaaEncFilter)

Summarises what filter selects from catalog: each cell counts once even when it lies in several selected states, districts or regions.

public static (int CellCount, long TotalBytes) Summarize(NoaaEncProductCatalog catalog, NoaaEncFilter filter)

Parameters

catalog NoaaEncProductCatalog

filter NoaaEncFilter

Returns

(int CellCount, long TotalBytes)