Class BarCodeMatch

Namespace

Acuit.Pinpoint.Common.BarCodes

Assembly

Acuit.Pinpoint.Common.dll

The numbers found in a bar code from a given bar code definition.

public class BarCodeMatch

Inheritance

object

BarCodeMatch

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

BarCodeMatch()

Initializes a new instance of the BarCodeMatch class.

public BarCodeMatch()

Properties

Count

Gets the number of numbers found in the bar code.

public int Count { get; }

Property Value

int

Methods

AddNumber(string, string)

Adds a number.

public void AddNumber(string id, string value)

Parameters

id string

The number identifier.

value string

The number value.

Exceptions

ArgumentNullException

id is null.

ArgumentNullException

value is null.

ContainsNumber(string)

Gets whether the given number exists in the collection of numbers.

public bool ContainsNumber(string id)

Parameters

id string

The number identifier.

Returns

bool

true if the number exists; otherwise, false.

Exceptions

ArgumentNullException

id is null.

GetNumber(string)

Gets a number from the collection of numbers.

public string GetNumber(string id)

Parameters

id string

The identifier of the number to get.

Returns

string

The value for the number with the given identifier.

Exceptions

ArgumentNullException

id is null.

KeyNotFoundException

A number with the given identifier does not exist.

TryGetNumber(string, out string)

Tries to get a number from a collection of numbers.

public bool TryGetNumber(string id, out string value)

Parameters

id string

The identifier of the number to get.

value string

When this method returns, contains the number value, if the number was found; otherwise, null.

Returns

bool

true if the number was found; otherwise, false.

Exceptions

ArgumentNullException

id is null.