Table of Contents

Class BarCodeMatcher

Namespace
Acuit.Pinpoint.Common.BarCodes
Assembly
Acuit.Pinpoint.Common.dll

The base class for bar code matchers, which attempt to match against the content of bar codes, extracting one or more "numbers".

public abstract class BarCodeMatcher
Inheritance
BarCodeMatcher
Derived
Inherited Members

Constructors

BarCodeMatcher()

protected BarCodeMatcher()

Properties

NumberIds

Gets the list of number identifiers that this bar code matcher can capture.

public abstract IReadOnlyList<string> NumberIds { get; }

Property Value

IReadOnlyList<string>

Methods

TryMatchBarCode(string, out IReadOnlyDictionary<string, string>?)

Tries to match a bar code.

public abstract bool TryMatchBarCode(string barCode, out IReadOnlyDictionary<string, string>? numbers)

Parameters

barCode string

The bar code content.

numbers IReadOnlyDictionary<string, string>

On return, if the bar code content matched, the numbers found in the bar code as a dictionary keyed by their number identifiers (case-sensitive); otherwise, null.

Returns

bool

true if the bar code matches; othersise, false.

Exceptions

ArgumentNullException

barCode is null.