Package io.scanbot.sdk.barcode

Class BarcodeFormatRoyalMailConfiguration

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatFourStateConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatRoyalMailConfiguration

public class BarcodeFormatRoyalMailConfiguration
extends BarcodeFormatFourStateConfigurationBase

Royal Mail barcode configuration. Add to scanner configuration to scan Royal Mail (a.k.a. RM4SCC, CBC, BPO 4-State) barcodes.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatRoyalMailConfiguration()	Constructs BarcodeFormatRoyalMailConfiguration with default parameters.
BarcodeFormatRoyalMailConfiguration(java.lang.String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, boolean stripCheckDigits)	Constructs BarcodeFormatRoyalMailConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
boolean	getStripCheckDigits()	Getter for stripCheckDigits field.
void	setStripCheckDigits(boolean stripCheckDigits)	Setter for stripCheckDigits field.

Methods inherited from class io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

getAddAdditionalQuietZone, getMinimumSizeScore, getRegexFilter, setAddAdditionalQuietZone, setMinimumSizeScore, setRegexFilter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BarcodeFormatRoyalMailConfiguration

public BarcodeFormatRoyalMailConfiguration(java.lang.String regexFilter,
                                           double minimumSizeScore,
                                           boolean addAdditionalQuietZone,
                                           boolean stripCheckDigits)

Constructs BarcodeFormatRoyalMailConfiguration with the given params.

Parameters:

regexFilter - Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off). Default is ""

minimumSizeScore - Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is. Default is 0

addAdditionalQuietZone - If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode. Default is false

stripCheckDigits - If true, the check digits are stripped from the result. Default is false

BarcodeFormatRoyalMailConfiguration

public BarcodeFormatRoyalMailConfiguration()

Constructs BarcodeFormatRoyalMailConfiguration with default parameters.

Method Detail

getStripCheckDigits

public boolean getStripCheckDigits()

Getter for stripCheckDigits field. See constructor documentation for more information about the field.

Returns:

stripCheckDigits

setStripCheckDigits

public void setStripCheckDigits(boolean stripCheckDigits)

Setter for stripCheckDigits field. See constructor documentation for more information about the field.

Parameters:

stripCheckDigits - Value to set.