Class S100CatalogueFilter

Namespace

EncDotNet.S100.Collections

Assembly

EncDotNet.S100.Collections.dll

Selects datasets from a remote S-100 exchange catalogue by folder (for NOAA's S-102, a region such as Northeast or an area such as Northeast/Long_Island_Sound) and by navigation purpose (e.g. port, transit). An empty list leaves that facet unscoped.

public sealed record S100CatalogueFilter : IEquatable<S100CatalogueFilter>

Inheritance

object

S100CatalogueFilter

Implements

IEquatable<S100CatalogueFilter>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

All

A filter that matches every dataset.

public static S100CatalogueFilter All { get; }

Property Value

S100CatalogueFilter

Folders

Folders relative to the exchange set's root (forward slashes); a dataset matches a folder it lies in or below. Matched case-insensitively.

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

Property Value

IReadOnlyList<string>

IsUnscoped

True when neither folders nor purposes are selected.

public bool IsUnscoped { get; }

Property Value

bool

NavigationPurposes

Navigation purposes (the catalogue's navigationPurpose), matched case-insensitively.

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

Property Value

IReadOnlyList<string>

Methods

Equals(S100CatalogueFilter?)

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

public bool Equals(S100CatalogueFilter? other)

Parameters

other S100CatalogueFilter

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(string, string?)

Returns true when a dataset in folder with navigationPurpose passes the filter.

public bool Matches(string folder, string? navigationPurpose)

Parameters

folder string

navigationPurpose string

Returns

bool

MatchesFolder(string)

Returns true when folder is, or lies below, a selected folder (or none is selected).

public bool MatchesFolder(string folder)

Parameters

folder string

Returns

bool

ToCanonicalString()

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

public string ToCanonicalString()

Returns

string