SymbologySettings Class Reference

Public Member Functions
void	SetExtensionEnabled (String extension, boolean enabled)
boolean	IsExtensionEnabled (String extension)
short[]	GetActiveSymbolCounts ()
void	SetActiveSymbolCounts (short[] counts)

Public Attributes
boolean	Enabled
boolean	ColorInvertedEnabled
int	Checksums
readonly int	Symbology

Static Public Attributes
Optional Checksums
static int	ChecksumNone
static int	ChecksumMod10
static int	ChecksumMod11
static int	ChecksumMod47
static int	ChecksumMod43
static int	ChecksumMod103
static int	ChecksumMod1010
static int	ChecksumMod1110
Custom Symbology Extensions
These constant define symbology extensions that can be enabled by SetExtensionEnabled()
const String	ExtensionTiny
const String	ExtensionFullAscii
const String	ExtensionRemoveLeadingZero

Detailed Description

Contains settings that affect the decoding of a specific symboloy.

The symbology settings class holds all settings that apply to a certain barcode symbology, such as whether the symbology is enabled, the enabled checksums etc.

Since

4.7.0

Member Function Documentation

SetExtensionEnabled()

void SetExtensionEnabled	(	String	extension,
		boolean	enabled
	)

Activate/Deactivate a custom extension for the symbology.

Extensions are custom features that are only supported by a small number of symbologies. For a list of supported extensions, consult the constants of this class.

Parameters

extension	Name of the extension.
enabled	Whether the extension should be enabled/disabled.

Since

4.7.0

IsExtensionEnabled()

boolean IsExtensionEnabled

(

String

extension

)

Determine whether a certain extension is enabled for the symbology.

Extensions are custom features that are only supported by a small number of symbologies. For a list of supported extensions, consult the constants of this class.

Parameters

extension

Name of the extension.

Returns

True if the extension is enabled, false if not.

Since

4.7.0

GetActiveSymbolCounts()

short [] GetActiveSymbolCounts

(

)

Control the length of barcodes to be decoded.

Change this property enable decoding of long codes which can not be decoded with the default settings, or to optimize decoder performance for codes of certain lengths. This is useful when it is known that the application only requires scanning of particular barcode lengths.

The mapping from characters to symbols is symbology-specific. For some symbologies, the start and end characters are included, others include checksums characters in the symbol counts.

The active symbol count setting is ignored for fixed-size barcodes (the EAN and UPC family of codes) as well as 2d codes. For other symbologies, see Calculating symbol counts for variable-length symbologies.

Returns

array of enabled active symbol counts.

Since

4.8.0

SetActiveSymbolCounts()

void SetActiveSymbolCounts

(

short[]

counts

)

Change the length of barcodes to be decoded.

See also

GetActiveSymbolCounts

Parameters

counts

List of new active symbol counts to use.

Since

4.8.0

Member Data Documentation

ChecksumNone

int ChecksumNone

static

No optional checksum.

ChecksumMod10

int ChecksumMod10

static

Modulo 10 checksum.

ChecksumMod11

int ChecksumMod11

static

Modulo 11 checksum.

ChecksumMod47

int ChecksumMod47

static

Modulo 47 checksum.

ChecksumMod43

int ChecksumMod43

static

Modulo 43 checksum.

ChecksumMod103

int ChecksumMod103

static

Modulo 103 checksum.

ChecksumMod1010

int ChecksumMod1010

static

Two modulo 10 checksums.

ChecksumMod1110

int ChecksumMod1110

static

A modulo 11 and a modulo 10 checksum.

ExtensionTiny

const String ExtensionTiny

static

Enable decoder optimizations for small data-matrix codes.

ExtensionFullAscii

const String ExtensionFullAscii

static

Full-ASCII Code39 extension.

ExtensionRemoveLeadingZero

const String ExtensionRemoveLeadingZero

static

Remove leading zero of UPCA codes.

When enabled, the leading zero of UPCA codes is removed. When false (the default), the leading zero is returned as part of the barcode data string

Enabled

boolean Enabled

Whether decoding of this symbology is enabled.

This property only enables/disables decoding of dark codes on bright background. If color- inverted (bright on dark) codes for this symbology are required, enable them through the colorInvertedEnabled property. By default decoding of all symbologies is disabled.

It is advised to only enable symbologies that are required by the application as every enabled symbology adds processing overhead.

Since

4.7.0

ColorInvertedEnabled

boolean ColorInvertedEnabled

Whether color-inverted decoding of this symbology is enabled.

This property only enables/disables decoding of bright codes on dark background. By default color-inverted decoding of all symbologies is disabled.

It is advised to only enable symbologies that are required by the application as every enabled symbology adds processing overhead.

Since

4.7.0

Checksums

int Checksums

Get active optional checksums for this symbology.

This property contains the additional checksums for this symbology. When a barcode has been decoded, the checksums contained are evaluated in addition to any mandatory checksum defined by the symbology specification. If any of the checksums matches, the code is returned as recognized, otherwise it is discarded.

At the moment, only one optional checksum is supported. This might change for future versions.

Since

4.7.0

Symbology

readonly int Symbology

The symbology these symbology settings apply to.

Since

4.7.0