All Implemented Interfaces:: android.os.Parcelable


public final class BarcodeFormatRoyalMailConfiguration
extends BarcodeFormatFourStateConfigurationBase implements Parcelable

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

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`_type`
`private String`	`regexFilter`
`private Double`	`minimumSizeScore`
`private Boolean`	`addAdditionalQuietZone`
`private Boolean`	`stripCheckDigits`

Constructor Summary

Constructors
Constructor	Description
`BarcodeFormatRoyalMailConfiguration(Map<String, Object> source)`
`BarcodeFormatRoyalMailConfiguration(JSONObject json)`
`BarcodeFormatRoyalMailConfiguration(String regexFilter, Double minimumSizeScore, Boolean addAdditionalQuietZone, Boolean stripCheckDigits)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`get_type()`
`String`	`getRegexFilter()`	Regular expression filter for barcode text.
`Unit`	`setRegexFilter(String regexFilter)`	Regular expression filter for barcode text.
`Double`	`getMinimumSizeScore()`	Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1).
`Unit`	`setMinimumSizeScore(Double minimumSizeScore)`	Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1).
`Boolean`	`getAddAdditionalQuietZone()`	If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
`Unit`	`setAddAdditionalQuietZone(Boolean addAdditionalQuietZone)`	If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
`final Boolean`	`getStripCheckDigits()`	If true, the check digits are stripped from the result.
`final Unit`	`setStripCheckDigits(Boolean stripCheckDigits)`	If true, the check digits are stripped from the result.
`JSONObject`	`toJson(ToJsonConfiguration config)`
`BarcodeFormatRoyalMailConfiguration`	`clone()`
`final static BarcodeFormatRoyalMailConfiguration`	`default()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BarcodeFormatRoyalMailConfiguration
```
BarcodeFormatRoyalMailConfiguration(Map<String, Object> source)
```
  - BarcodeFormatRoyalMailConfiguration
```
BarcodeFormatRoyalMailConfiguration(JSONObject json)
```
  - BarcodeFormatRoyalMailConfiguration
```
BarcodeFormatRoyalMailConfiguration(String regexFilter, Double minimumSizeScore, Boolean addAdditionalQuietZone, Boolean stripCheckDigits)
```
- Method Detail
  - get_type
```
 String get_type()
```
  - getRegexFilter
```
 String getRegexFilter()
```
    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 ""
  - setRegexFilter
```
 Unit setRegexFilter(String 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 ""
  - getMinimumSizeScore
```
 Double getMinimumSizeScore()
```
    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
  - setMinimumSizeScore
```
 Unit setMinimumSizeScore(Double 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
  - getAddAdditionalQuietZone
```
 Boolean getAddAdditionalQuietZone()
```
    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
  - setAddAdditionalQuietZone
```
 Unit setAddAdditionalQuietZone(Boolean 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
  - getStripCheckDigits
```
 final Boolean getStripCheckDigits()
```
    If true, the check digits are stripped from the result.
    Default is false
  - setStripCheckDigits
```
 final Unit setStripCheckDigits(Boolean stripCheckDigits)
```
    If true, the check digits are stripped from the result.
    Default is false
  - toJson
```
 JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 BarcodeFormatRoyalMailConfiguration clone()
```
  - default
```
 final static BarcodeFormatRoyalMailConfiguration default()
```

Class BarcodeFormatRoyalMailConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BarcodeFormatRoyalMailConfiguration

BarcodeFormatRoyalMailConfiguration

BarcodeFormatRoyalMailConfiguration

Method Detail

get_type

getRegexFilter

setRegexFilter

getMinimumSizeScore

setMinimumSizeScore

getAddAdditionalQuietZone

setAddAdditionalQuietZone

getStripCheckDigits

setStripCheckDigits

toJson

clone

default