IcareDecoders

java.lang.Object
- ch.icare.smartscan.utils.IcareDecoders

public class IcareDecoders
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`CODE_1D2D`
`static long`	`CODE_AZTEC`
`static long`	`CODE_BVR`
`static long`	`CODE_CH_DRV_LICENSES`
`static long`	`CODE_CODE128`
`static long`	`CODE_CODE39`
`static long`	`CODE_DATABARS`
`static long`	`CODE_DATAMATRIX`
`static long`	`CODE_EAN13`
`static long`	`CODE_EAN8`
`static long`	`CODE_EU_PLATES`
`static long`	`CODE_FRENCH_IDS`
`static long`	`CODE_ICAO_9303_IDCARD`
`static long`	`CODE_ICAO_9303_PASSPORT`
`static long`	`CODE_ICAO_9303_VISA`
`static long`	`CODE_INSURANCE_CARDS`
`static long`	`CODE_NO_SUB_TYPE`
`static long`	`CODE_NO_TYPE`
`static long`	`CODE_OCRB`
`static long`	`CODE_PLT_AUT`
`static long`	`CODE_PLT_BEL`
`static long`	`CODE_PLT_BGR`
`static long`	`CODE_PLT_CHE`
`static long`	`CODE_PLT_CZE`
`static long`	`CODE_PLT_DEU`
`static long`	`CODE_PLT_DNK`
`static long`	`CODE_PLT_ESP`
`static long`	`CODE_PLT_EST`
`static long`	`CODE_PLT_FIN`
`static long`	`CODE_PLT_FRA`
`static long`	`CODE_PLT_GRC`
`static long`	`CODE_PLT_HRV`
`static long`	`CODE_PLT_HUN`
`static long`	`CODE_PLT_ITA`
`static long`	`CODE_PLT_LIE`
`static long`	`CODE_PLT_LTU`
`static long`	`CODE_PLT_LUX`
`static long`	`CODE_PLT_LVA`
`static long`	`CODE_PLT_NLD`
`static long`	`CODE_PLT_POL`
`static long`	`CODE_PLT_PRT`
`static long`	`CODE_PLT_ROU`
`static long`	`CODE_PLT_SVK`
`static long`	`CODE_PLT_SVN`
`static long`	`CODE_PLT_SWE`
`static long`	`CODE_PLT_UUU`
`static long`	`CODE_QRC`
`static long`	`CODE_ROMANIAN_IDS`
`static long`	`CODE_SWISS_PLATES`
`static long`	`CODE_TEST`
`static long`	`CODE_UPCE`
`static int`	`ERROR_INVALID_BUNDLE_NAME`
`static int`	`ERROR_LICENSE_EXPIRED`
`static int`	`ERROR_NOTHING_TO_READ`
`static int`	`ERROR_ROI_OUT_OF_BOUNDS`
`static int`	`ERROR_UNKNOWN`
`static int`	`ERROR_UNKNOWN_TRUN_COMMAND`
`static int`	`ERROR_UNSUPPORTED_TYPE_OF_CODE`
`static int`	`FAILURE`
`static int`	`PARTIAL_RESULT`
`static int`	`SUCCESS`

Constructor Summary

Constructors
Constructor and Description

IcareDecoders()

Constructors
Constructor and Description
`IcareDecoders()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getCodeDescription(long typeofcode, long subtypeofcode)` Returns a brief text description of a given type of code
`static TargetRatio`	`getPreferredRegionOfInterestRatios(long typeofcode, long subtypeofcode)` Returns the preferred region of interest (in Ratios, not pixels) for a given code The region of interest is the part of the image that will be scanned, the rest of the image will be ignored.
`static TargetRatio`	`getPreferredUITargetRatios(long typeofcode)` Returns a target (in ratios, not pixels) that can help the user to target the code more correctly
`static Ratio`	`getRecommendedROIRatio(long codeType, long codeSubType)` Returns the recommended ratio for decoding target, to avoid other signs disturbing the decoding process.
`static java.lang.String`	`getReturnCodeDescription(int returncode)` Returns a brief text description of a given return code

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

- Field Detail
  - SUCCESS
```
public static final int SUCCESS
```
    See Also:
    
    Constant Field Values
  - FAILURE
```
public static final int FAILURE
```
    See Also:
    
    Constant Field Values
  - PARTIAL_RESULT
```
public static final int PARTIAL_RESULT
```
    See Also:
    
    Constant Field Values
  - ERROR_UNKNOWN
```
public static final int ERROR_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - ERROR_NOTHING_TO_READ
```
public static final int ERROR_NOTHING_TO_READ
```
    See Also:
    
    Constant Field Values
  - ERROR_UNSUPPORTED_TYPE_OF_CODE
```
public static final int ERROR_UNSUPPORTED_TYPE_OF_CODE
```
    See Also:
    
    Constant Field Values
  - ERROR_UNKNOWN_TRUN_COMMAND
```
public static final int ERROR_UNKNOWN_TRUN_COMMAND
```
    See Also:
    
    Constant Field Values
  - ERROR_ROI_OUT_OF_BOUNDS
```
public static final int ERROR_ROI_OUT_OF_BOUNDS
```
    See Also:
    
    Constant Field Values
  - ERROR_INVALID_BUNDLE_NAME
```
public static final int ERROR_INVALID_BUNDLE_NAME
```
    See Also:
    
    Constant Field Values
  - ERROR_LICENSE_EXPIRED
```
public static final int ERROR_LICENSE_EXPIRED
```
    See Also:
    
    Constant Field Values
  - CODE_NO_TYPE
```
public static final long CODE_NO_TYPE
```
    See Also:
    
    Constant Field Values
  - CODE_OCRB
```
public static final long CODE_OCRB
```
    See Also:
    
    Constant Field Values
  - CODE_EU_PLATES
```
public static final long CODE_EU_PLATES
```
    See Also:
    
    Constant Field Values
  - CODE_SWISS_PLATES
```
public static final long CODE_SWISS_PLATES
```
    See Also:
    
    Constant Field Values
  - CODE_1D2D
```
public static final long CODE_1D2D
```
    See Also:
    
    Constant Field Values
  - CODE_INSURANCE_CARDS
```
public static final long CODE_INSURANCE_CARDS
```
    See Also:
    
    Constant Field Values
  - CODE_TEST
```
public static final long CODE_TEST
```
    See Also:
    
    Constant Field Values
  - CODE_NO_SUB_TYPE
```
public static final long CODE_NO_SUB_TYPE
```
    See Also:
    
    Constant Field Values
  - CODE_BVR
```
public static final long CODE_BVR
```
    See Also:
    
    Constant Field Values
  - CODE_ICAO_9303_PASSPORT
```
public static final long CODE_ICAO_9303_PASSPORT
```
    See Also:
    
    Constant Field Values
  - CODE_ICAO_9303_IDCARD
```
public static final long CODE_ICAO_9303_IDCARD
```
    See Also:
    
    Constant Field Values
  - CODE_ICAO_9303_VISA
```
public static final long CODE_ICAO_9303_VISA
```
    See Also:
    
    Constant Field Values
  - CODE_FRENCH_IDS
```
public static final long CODE_FRENCH_IDS
```
    See Also:
    
    Constant Field Values
  - CODE_ROMANIAN_IDS
```
public static final long CODE_ROMANIAN_IDS
```
    See Also:
    
    Constant Field Values
  - CODE_CH_DRV_LICENSES
```
public static final long CODE_CH_DRV_LICENSES
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_UUU
```
public static final long CODE_PLT_UUU
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_CHE
```
public static final long CODE_PLT_CHE
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_FRA
```
public static final long CODE_PLT_FRA
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_ITA
```
public static final long CODE_PLT_ITA
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_DEU
```
public static final long CODE_PLT_DEU
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_BEL
```
public static final long CODE_PLT_BEL
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_NLD
```
public static final long CODE_PLT_NLD
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_AUT
```
public static final long CODE_PLT_AUT
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_LIE
```
public static final long CODE_PLT_LIE
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_PRT
```
public static final long CODE_PLT_PRT
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_LUX
```
public static final long CODE_PLT_LUX
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_SVN
```
public static final long CODE_PLT_SVN
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_HRV
```
public static final long CODE_PLT_HRV
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_CZE
```
public static final long CODE_PLT_CZE
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_ESP
```
public static final long CODE_PLT_ESP
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_POL
```
public static final long CODE_PLT_POL
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_ROU
```
public static final long CODE_PLT_ROU
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_SVK
```
public static final long CODE_PLT_SVK
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_HUN
```
public static final long CODE_PLT_HUN
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_BGR
```
public static final long CODE_PLT_BGR
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_SWE
```
public static final long CODE_PLT_SWE
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_FIN
```
public static final long CODE_PLT_FIN
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_DNK
```
public static final long CODE_PLT_DNK
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_EST
```
public static final long CODE_PLT_EST
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_LVA
```
public static final long CODE_PLT_LVA
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_LTU
```
public static final long CODE_PLT_LTU
```
    See Also:
    
    Constant Field Values
  - CODE_PLT_GRC
```
public static final long CODE_PLT_GRC
```
    See Also:
    
    Constant Field Values
  - CODE_DATAMATRIX
```
public static final long CODE_DATAMATRIX
```
    See Also:
    
    Constant Field Values
  - CODE_EAN13
```
public static final long CODE_EAN13
```
    See Also:
    
    Constant Field Values
  - CODE_EAN8
```
public static final long CODE_EAN8
```
    See Also:
    
    Constant Field Values
  - CODE_UPCE
```
public static final long CODE_UPCE
```
    See Also:
    
    Constant Field Values
  - CODE_CODE128
```
public static final long CODE_CODE128
```
    See Also:
    
    Constant Field Values
  - CODE_CODE39
```
public static final long CODE_CODE39
```
    See Also:
    
    Constant Field Values
  - CODE_DATABARS
```
public static final long CODE_DATABARS
```
    See Also:
    
    Constant Field Values
  - CODE_QRC
```
public static final long CODE_QRC
```
    See Also:
    
    Constant Field Values
  - CODE_AZTEC
```
public static final long CODE_AZTEC
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IcareDecoders
```
public IcareDecoders()
```
- Method Detail
  - getReturnCodeDescription
```
public static java.lang.String getReturnCodeDescription(int returncode)
```
    Returns a brief text description of a given return code
  - getCodeDescription
```
public static java.lang.String getCodeDescription(long typeofcode,
                                                  long subtypeofcode)
```
    Returns a brief text description of a given type of code
  - getRecommendedROIRatio
```
public static Ratio getRecommendedROIRatio(long codeType,
                                           long codeSubType)
```
    Returns the recommended ratio for decoding target, to avoid other signs disturbing the decoding process. This is only an indication and is what is used by default when {Smartscanner.setDecodingType(long, long), setDecodingType} is called.
    
    Parameters:
    
    codeType -
    
    codeSubType -
    
    Returns:
    
    Ratio (height / width)
  - getPreferredRegionOfInterestRatios
```
public static TargetRatio getPreferredRegionOfInterestRatios(long typeofcode,
                                                             long subtypeofcode)
```
    Returns the preferred region of interest (in Ratios, not pixels) for a given code The region of interest is the part of the image that will be scanned, the rest of the image will be ignored.
  - getPreferredUITargetRatios
```
public static TargetRatio getPreferredUITargetRatios(long typeofcode)
```
    Returns a target (in ratios, not pixels) that can help the user to target the code more correctly

Class IcareDecoders

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SUCCESS

FAILURE

PARTIAL_RESULT

ERROR_UNKNOWN

ERROR_NOTHING_TO_READ

ERROR_UNSUPPORTED_TYPE_OF_CODE

ERROR_UNKNOWN_TRUN_COMMAND

ERROR_ROI_OUT_OF_BOUNDS

ERROR_INVALID_BUNDLE_NAME

ERROR_LICENSE_EXPIRED

CODE_NO_TYPE

CODE_OCRB

CODE_EU_PLATES

CODE_SWISS_PLATES

CODE_1D2D

CODE_INSURANCE_CARDS

CODE_TEST

CODE_NO_SUB_TYPE

CODE_BVR

CODE_ICAO_9303_PASSPORT

CODE_ICAO_9303_IDCARD

CODE_ICAO_9303_VISA

CODE_FRENCH_IDS

CODE_ROMANIAN_IDS

CODE_CH_DRV_LICENSES

CODE_PLT_UUU

CODE_PLT_CHE

CODE_PLT_FRA

CODE_PLT_ITA

CODE_PLT_DEU

CODE_PLT_BEL

CODE_PLT_NLD

CODE_PLT_AUT

CODE_PLT_LIE

CODE_PLT_PRT

CODE_PLT_LUX

CODE_PLT_SVN

CODE_PLT_HRV

CODE_PLT_CZE

CODE_PLT_ESP

CODE_PLT_POL

CODE_PLT_ROU

CODE_PLT_SVK

CODE_PLT_HUN

CODE_PLT_BGR

CODE_PLT_SWE

CODE_PLT_FIN

CODE_PLT_DNK

CODE_PLT_EST

CODE_PLT_LVA

CODE_PLT_LTU

CODE_PLT_GRC

CODE_DATAMATRIX

CODE_EAN13

CODE_EAN8

CODE_UPCE

CODE_CODE128

CODE_CODE39

CODE_DATABARS

CODE_QRC

CODE_AZTEC

Constructor Detail

IcareDecoders

Method Detail

getReturnCodeDescription

getCodeDescription

getRecommendedROIRatio

getPreferredRegionOfInterestRatios

getPreferredUITargetRatios