to top
Datalogic APIs
public class

ScannerOptions

extends PropertyGroup
java.lang.Object
   ↳ com.datalogic.device.configuration.PropertyGroup
     ↳ com.datalogic.decode.configuration.ScannerOptions

Class Overview

ScannerOptions is the class that configures the scanner target beam and other scanner functionalities.

Summary

Fields
public BooleanProperty aimEnable aimEnable enables aim projection when capturing frames.
public NumericProperty customImageCaptureProfile customImageCaptureProfile allows to define a custom profile.
public NumericProperty decodeTimeout decodeTimeout is the maximum time the scanner remains on without reading a barcode.
public BooleanProperty displayModeEnable displayModeEnable barcode illumination management for capturing frames from displys or reflective surfaces.
public NumericProperty doubleReadTimeout doubleReadTimeout is the minimum time allowed between reads of the same barcode label.
public BooleanProperty illuminationEnable illuminationEnable enables barcode illumination when capturing frames.
public EnumProperty<IlluminationTime> illuminationTime illuminationTime selects the scanner illumination pulse length.
public EnumProperty<IlluminationType> illuminationType illuminationType selects the scanner illuminator to be used for decoding.
public EnumProperty<ImageCaptureProfile> imageCaptureProfile imageCaptureProfile selects the scanner image capture profile.
public BooleanProperty picklistEnable picklistEnable limits reading to targeted selection.
public EnumProperty<ScanMode> scanMode scanMode selects the scan mode.
public EnumProperty<BeamMode> targetMode targetMode selects the scanner target beam mode.
public BooleanProperty targetModeEnable targetModeEnable enables the use of a target beam mode.
public NumericProperty targetReleaseTimeout targetReleaseTimeout is the maximum time the scanner is on after trigger release when using Release Scan target beam mode.
public NumericProperty targetTimeout targetTimeout is time the target beam is on before scanner attempts to read.
Public Constructors
ScannerOptions(PropertyGetter editor)
This is the constructor of ScannerOptions.
[Expand]
Inherited Methods
From class com.datalogic.device.configuration.PropertyGroup
From class java.lang.Object

Fields

public BooleanProperty aimEnable

Added in revision 1

aimEnable enables aim projection when capturing frames.

public NumericProperty customImageCaptureProfile

Added in revision 20

customImageCaptureProfile allows to define a custom profile. It could be set with a number between 0-255.

public NumericProperty decodeTimeout

Added in revision 1

decodeTimeout is the maximum time the scanner remains on without reading a barcode. If the value exceeds the range, the value is set at full scale. The amount of time is represented in milliseconds.

public BooleanProperty displayModeEnable

Added in revision 10

displayModeEnable barcode illumination management for capturing frames from displys or reflective surfaces. The possibile configurations are: - feature disabled. Illuminator alwayas enabled; - feature enabled. Illuminator adjusted according to reflection in the previous acquired frames.

public NumericProperty doubleReadTimeout

Added in revision 27

doubleReadTimeout is the minimum time allowed between reads of the same barcode label. When the device decodes a label and sees the same one before this timeout is expired, the second result will be ignored. This timeout works when scanMode is set to HOLD_MULTIPLE, PULSE_MULTIPLE or ALWAYS_ON. The amount of time is represented in milliseconds.

public BooleanProperty illuminationEnable

Added in revision 1

illuminationEnable enables barcode illumination when capturing frames.

public EnumProperty<IlluminationTime> illuminationTime

Added in revision 28

illuminationTime selects the scanner illumination pulse length. The scan engine illumination is a pulsed light. It is characterized by a light pulse length and a frequency usually equal to the frame rate frequency. This property affects only the pulse length. With a longer light pulse the scan engine can decode a more distant target and DOF performance is enhanced on low environment light condition. In the counterside, a shorter light pulse makes the scan engine more motion tollerant.

public EnumProperty<IlluminationType> illuminationType

Added in revision 20

illuminationType selects the scanner illuminator to be used for decoding.

public EnumProperty<ImageCaptureProfile> imageCaptureProfile

Added in revision 19

imageCaptureProfile selects the scanner image capture profile.

public BooleanProperty picklistEnable

Added in revision 1

picklistEnable limits reading to targeted selection.

public EnumProperty<ScanMode> scanMode

Added in revision 27

scanMode selects the scan mode.

public EnumProperty<BeamMode> targetMode

Added in revision 1

targetMode selects the scanner target beam mode.

public BooleanProperty targetModeEnable

Added in revision 1

targetModeEnable enables the use of a target beam mode.

public NumericProperty targetReleaseTimeout

Added in revision 1

targetReleaseTimeout is the maximum time the scanner is on after trigger release when using Release Scan target beam mode. If the value exceeds the range, the value is set at full scale.

public NumericProperty targetTimeout

Added in revision 1

targetTimeout is time the target beam is on before scanner attempts to read. 0=0.25 seconds, 1 to 4= 0.5 to 2 seconds. If the value exceeds the range, the value is set at full scale.

Public Constructors

public ScannerOptions (PropertyGetter editor)

Added in revision 1

This is the constructor of ScannerOptions. All options are initialized by editor.

Parameters
editor A PropertyGetter used to load the current barcode family.