Class NoaaEncFilter

Namespace

EncDotNet.S100.Collections

Assembly

EncDotNet.S100.Collections.dll

Selects cells from the NOAA ENC product catalogue by state, Coast Guard district or region.

public sealed record NoaaEncFilter : IEquatable<NoaaEncFilter>

Inheritance

object

NoaaEncFilter

Implements

IEquatable<NoaaEncFilter>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A cell matches when it lies in any selected state, district or region (the selections are unioned). With nothing selected, every cell matches. Cancelled cells are excluded unless IncludeCancelled is set.

Properties

All

A filter that matches every active cell.

public static NoaaEncFilter All { get; }

Property Value

NoaaEncFilter

CoastGuardDistricts

US Coast Guard district numbers.

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

Property Value

IReadOnlyList<int>

IncludeCancelled

Whether cancelled cells are included.

public bool IncludeCancelled { get; init; }

Property Value

bool

IsUnscoped

True when no state, district or region is selected.

public bool IsUnscoped { get; }

Property Value

bool

Regions

NOAA region numbers.

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

Property Value

IReadOnlyList<int>

States

Two-letter state or territory codes (e.g. AK).

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

Property Value

IReadOnlyList<string>

Methods

Equals(NoaaEncFilter?)

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

public bool Equals(NoaaEncFilter? other)

Parameters

other NoaaEncFilter

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.

Matches(NoaaEncCell)

Returns true when cell passes the filter.

public bool Matches(NoaaEncCell cell)

Parameters

cell NoaaEncCell

Returns

bool

ToCanonicalString()

A canonical text form, stable across list order, for fingerprints.

public string ToCanonicalString()

Returns

string