Class BarcodeScannerConfig
-
- All Implemented Interfaces:
public final class BarcodeScannerConfig
Entity represents configuration params for BarcodeScanner
-
-
Field Summary
Fields Modifier and Type Field Description private final List<BarcodeType>
barcodeFormats
private final BarcodeScanner.CoreEngineMode
coreEngineMode
private final Integer
minimumTextLength
private final Integer
maximumTextLength
private final Integer
minimum1DQuietZoneSize
private final Integer
gs1Handling
private final Integer
msiPlesseyChecksumAlgorithms
private final Boolean
stripCheckDigits
private final Boolean
lowPowerMode
private final Boolean
useIata2Of5Checksum
private final Boolean
useCode11Checksum
private final Integer
australiaPostCustomerFormat
private final Boolean
addAdditionalQuietZone
-
Constructor Summary
Constructors Constructor Description BarcodeScannerConfig(List<BarcodeType> barcodeFormats, BarcodeScanner.CoreEngineMode coreEngineMode, Integer minimumTextLength, Integer maximumTextLength, Integer minimum1DQuietZoneSize, Integer gs1Handling, Integer msiPlesseyChecksumAlgorithms, Boolean stripCheckDigits, Boolean lowPowerMode, Boolean useIata2Of5Checksum, Boolean useCode11Checksum, Integer australiaPostCustomerFormat, Boolean addAdditionalQuietZone)
-
Method Summary
Modifier and Type Method Description final List<BarcodeType>
getBarcodeFormats()
List of formats to scan. final BarcodeScanner.CoreEngineMode
getCoreEngineMode()
Defines used engine mode. final Integer
getMinimumTextLength()
Minimum required text length of the detected barcode. final Integer
getMaximumTextLength()
Maximum text length of the detected barcode. final Integer
getMinimum1DQuietZoneSize()
Minimum required quiet zone on the barcode. final Integer
getGs1Handling()
Handling mode for GS1-formatted results. final Integer
getMsiPlesseyChecksumAlgorithms()
The checksum algorithms for MSI Plessey barcodes. final Boolean
getStripCheckDigits()
If true, check digits for UPC, EAN and MSI Plessey codes are removed from result. final Boolean
getLowPowerMode()
If true
, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed.final Boolean
getUseIata2Of5Checksum()
If true
, the IATA 2 of 5 barcode checksum is used.final Boolean
getUseCode11Checksum()
If true
, the Code 11 barcode checksum is used.final Integer
getAustraliaPostCustomerFormat()
Defines the format of the barcode data for the Australian Post customer barcode. final Boolean
getAddAdditionalQuietZone()
If true
, an additional quiet zone is addede to the input image Default isfalse
-
-
Constructor Detail
-
BarcodeScannerConfig
BarcodeScannerConfig(List<BarcodeType> barcodeFormats, BarcodeScanner.CoreEngineMode coreEngineMode, Integer minimumTextLength, Integer maximumTextLength, Integer minimum1DQuietZoneSize, Integer gs1Handling, Integer msiPlesseyChecksumAlgorithms, Boolean stripCheckDigits, Boolean lowPowerMode, Boolean useIata2Of5Checksum, Boolean useCode11Checksum, Integer australiaPostCustomerFormat, Boolean addAdditionalQuietZone)
-
-
Method Detail
-
getBarcodeFormats
final List<BarcodeType> getBarcodeFormats()
List of formats to scan. Defaults to BarcodeFormat.COMMON_CODES on SDK level.
-
getCoreEngineMode
final BarcodeScanner.CoreEngineMode getCoreEngineMode()
Defines used engine mode.
-
getMinimumTextLength
final Integer getMinimumTextLength()
Minimum required text length of the detected barcode. The default value is 0 (the setting is turned off). NOTE: Currently works for ITF and MSI Plessey barcodes only!
-
getMaximumTextLength
final Integer getMaximumTextLength()
Maximum text length of the detected barcode. Setting to zero removes the limit. The default value is 0 (the setting is turned off). NOTE: Currently works for ITF and MSI Plessey barcodes only!
-
getMinimum1DQuietZoneSize
final Integer getMinimum1DQuietZoneSize()
Minimum required quiet zone on the barcode. Measured in modules (the size of a minimal bar on the barcode). The default value is 10. NOTE: Currently works for ITF and MSI Plessey barcodes only!
-
getGs1Handling
final Integer getGs1Handling()
Handling mode for GS1-formatted results.
-
getMsiPlesseyChecksumAlgorithms
final Integer getMsiPlesseyChecksumAlgorithms()
The checksum algorithms for MSI Plessey barcodes. The default value is MSIPlesseyChecksumAlgorithm.Mod10.
-
getStripCheckDigits
final Boolean getStripCheckDigits()
If true, check digits for UPC, EAN and MSI Plessey codes are removed from result. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is
false
-
getLowPowerMode
final Boolean getLowPowerMode()
If
true
, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. Iffalse
- mode is disabled. The default isfalse
-
getUseIata2Of5Checksum
final Boolean getUseIata2Of5Checksum()
If
true
, the IATA 2 of 5 barcode checksum is used. Default istrue
-
getUseCode11Checksum
final Boolean getUseCode11Checksum()
If
true
, the Code 11 barcode checksum is used. Default istrue
-
getAustraliaPostCustomerFormat
final Integer getAustraliaPostCustomerFormat()
Defines the format of the barcode data for the Australian Post customer barcode. Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
-
getAddAdditionalQuietZone
final Boolean getAddAdditionalQuietZone()
If
true
, an additional quiet zone is addede to the input image Default isfalse
-
-
-
-