Interface IItemScanningService

Namespace

Acuit.Pinpoint.Workstation

Assembly

Acuit.Pinpoint.Workstation.Interfaces.dll

An item scanning service.

public interface IItemScanningService

Methods

GetComponentScanSettings(string)

Gets the item scan settings for a component type, as configured for this station type.

ItemScanSettings GetComponentScanSettings(string componentTypeName)

Parameters

componentTypeName string

The component type name.

Returns

ItemScanSettings

A new ItemScanSettings with the item scan settings.

Remarks

These settings can be used with StartScanningItem(ItemScanSettings).

Exceptions

ArgumentNullException

componentTypeName is null.

ArgumentException

The componentTypeName component type is not configured to be scanned at this station.

GetUnitScanSettings()

Gets the item scan settings for units, as configured for this station type.

ItemScanSettings GetUnitScanSettings()

Returns

ItemScanSettings

A new ItemScanSettings with the item scan settings.

Remarks

These settings can be used with StartScanningItem(ItemScanSettings).

Exceptions

InvalidOperationException

The line configuration is not valid.

StartScanningItem(ItemScanSettings)

Starts scanning an item.

IItemScanner StartScanningItem(ItemScanSettings settings)

Parameters

settings ItemScanSettings

The item scan settings.

Returns

IItemScanner

An IItemScanner for interacting with the item scanning process.

Remarks

Close() must be called to close the scanner, either after numbers have been received or the scanner is canceled. The scan window will never close on its own.

Exceptions

ArgumentNullException

settings is null.

InvalidOperationException

An item scanner is already active.