Class SecomFilter

Namespace

EncDotNet.S100.Collections

Assembly

EncDotNet.S100.Collections.dll

Selects objects from a SECOM service: by product specification (matched on this side, since services spell product types differently) and, optionally, by an area the service filters on. With nothing selected, every object matches.

public sealed record SecomFilter : IEquatable<SecomFilter>

Inheritance

object

SecomFilter

Implements

IEquatable<SecomFilter>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

All

A filter that matches every object.

public static SecomFilter All { get; }

Property Value

SecomFilter

GeometryWkt

A WKT polygon the objects must intersect, sent to the service as the geometry query parameter; null for no area.

public string? GeometryWkt { get; init; }

Property Value

string

IsUnscoped

True when no product is selected.

public bool IsUnscoped { get; }

Property Value

bool

ProductSpecs

Product specifications (e.g. S-124), matched case-insensitively.

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

Property Value

IReadOnlyList<string>

Methods

Equals(SecomFilter?)

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

public bool Equals(SecomFilter? other)

Parameters

other SecomFilter

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(CollectionItem)

Returns true when item is one of the selected products.

public bool Matches(CollectionItem item)

Parameters

item CollectionItem

Returns

bool

ToCanonicalString()

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

public string ToCanonicalString()

Returns

string