BarcodeSettings Class Reference

Inherits BaseJavaClass.

Public Member Functions
def	__init__ (self, javaClass)
def	getAustraliaPost (self)
	Gets AustraliaPost decoding parameters. More...
def	getChecksumValidation (self)
	Enable checksum validation during recognition for 1D and Postal barcodes. More...
def	getDetectEncoding (self)
	The flag which force engine to detect codetext encoding for Unicode codesets. More...
def	getStripFNC (self)
	Strip FNC1, FNC2, FNC3 characters from codetext. More...
def	init (self)
def	setChecksumValidation (self, value)
	Enable checksum validation during recognition for 1D and Postal barcodes. More...
def	setDetectEncoding (self, value)
	The flag which force engine to detect codetext encoding for Unicode codesets. More...
def	setStripFNC (self, value)
	Strip FNC1, FNC2, FNC3 characters from codetext. More...
Public Member Functions inherited from BaseJavaClass
def	getJavaClass (self)
def	getJavaClassName (self)
def	isNull (self)
def	printJavaClassName (self)
def	setJavaClass (self, javaClass)

Additional Inherited Members
Public Attributes inherited from BaseJavaClass
	javaClass
	javaClassName

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			javaClass
	)

Reimplemented from BaseJavaClass.

Member Function Documentation

getAustraliaPost()

def getAustraliaPost

(

self

)

Gets AustraliaPost decoding parameters.

Returns

: The AustraliaPost decoding parameters which make influence on recognized data of AustraliaPost symbology

getChecksumValidation()

def getChecksumValidation

(

self

)

Enable checksum validation during recognition for 1D and Postal barcodes.

Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar, PatchCode, Pharmacode, DataLogic2of5 Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, ItalianPost25, Matrix2of5, MSI, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies

Example

generator = Generation.BarcodeGenerator(Generation.EncodeTypes.EAN_13, "1234567890128")
generator.save(self.image_path_to_save, Generation.BarCodeImageFormat.PNG)
reader = Recognition.BarCodeReader(self.image_path_to_save, None,Recognition.DecodeType.EAN_13)
# checksum disabled
reader.getBarcodeSettings().setChecksumValidation(Recognition.ChecksumValidation.OFF)
results = reader.readBarCodes()
for result in results:
    print(f"\nBarCode Type: {result.getCodeTypeName()}")
    print(f"BarCode CodeText: {result.getCodeText()}")
    print(f"BarCode Value: {result.getExtended().getOneD().getValue()}")
    print(f"BarCode Checksum: {result.getExtended().getOneD().getCheckSum()}")

generator = Generation.BarcodeGenerator(Generation.EncodeTypes.EAN_13, "1234567890128")
generator.save(self.image_path_to_save, Generation.BarCodeImageFormat.PNG)
reader = Recognition.BarCodeReader(self.image_path_to_save, None,Recognition.DecodeType.EAN_13)
# checksum enabled
reader.getBarcodeSettings().setChecksumValidation(Recognition.ChecksumValidation.ON)
results = reader.readBarCodes()
for result in results:
    print(f"\nBarCode Type: {result.getCodeTypeName()}")
    print(f"BarCode CodeText: {result.getCodeText()}")
    print(f"BarCode Value: {result.getExtended().getOneD().getValue()}")
    print(f"BarCode Checksum: {result.getExtended().getOneD().getCheckSum()}")

Returns

:Enable checksum validation during recognition for 1D and Postal barcodes.

getDetectEncoding()

def getDetectEncoding

(

self

)

The flag which force engine to detect codetext encoding for Unicode codesets.

Default value is true. Example

generator = BarcodeGenerator(EncodeTypes.QR, "Слово"))
im = generator.generateBarcodeImage(BarcodeImageFormat.PNG)
 
# detects encoding for Unicode codesets is enabled
reader = Recognition.BarCodeReader(im, DecodeType.QR)
reader.getBarcodeSettings().setDetectEncoding(true)
for result in reader.readBarCodes():
    print ("BarCode CodeText: " +result.getCodeText())

# detect encoding is disabled
reader = Recognition.BarCodeReader(im, DecodeType.QR)
reader.getBarcodeSettings().setDetectEncoding(false)
for result in reader.readBarCodes():
    print ("BarCode CodeText: " +result.getCodeText())

Returns

:The flag which force engine to detect codetext encoding for Unicode codesets

getStripFNC()

def getStripFNC

(

self

)

Strip FNC1, FNC2, FNC3 characters from codetext.

Default value is false. Example

generator = Generation.BarcodeGenerator(Generation.EncodeTypes.GS_1_CODE_128, "(02)04006664241007(37)1(400)7019590754")
generator.save(self.image_path_to_save, Generation.BarCodeImageFormat.PNG)
reader = Recognition.BarCodeReader(self.image_path_to_save,None,Recognition.DecodeType.CODE_128)
# StripFNC disabled
reader.getBarcodeSettings().setStripFNC(False)
results = reader.readBarCodes()
for result in results:
    print(f"\nBarCode Type: {result.getCodeTypeName()}")
    print(f"BarCode CodeText: {result.getCodeText()}")

reader = Recognition.BarCodeReader(self.image_path_to_save,None,Recognition.DecodeType.CODE_128)
# StripFNC enabled
reader.getBarcodeSettings().setStripFNC(False)
results = reader.readBarCodes()
for result in results:
      print(f"\nBarCode Type: {result.getCodeTypeName()}")
      print(f"BarCode CodeText: {result.getCodeText()}")

Returns

: Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.

init()

def init

(

self

)

Reimplemented from BaseJavaClass.

setChecksumValidation()

def setChecksumValidation	(		self,
			value
	)

Enable checksum validation during recognition for 1D and Postal barcodes.

Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar, PatchCode, Pharmacode, DataLogic2of5 Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, ItalianPost25, Matrix2of5, MSI, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies

Example

generator = Generation.BarcodeGenerator(Generation.EncodeTypes.EAN_13, "1234567890128")
generator.save(self.image_path_to_save, Generation.BarCodeImageFormat.PNG)
reader = Recognition.BarCodeReader(self.image_path_to_save, None,Recognition.DecodeType.EAN_13)
# checksum disabled
reader.getBarcodeSettings().setChecksumValidation(Recognition.ChecksumValidation.OFF)
results = reader.readBarCodes()
for result in results:
    print(f"\nBarCode Type: {result.getCodeTypeName()}")
    print(f"BarCode CodeText: {result.getCodeText()}")
    print(f"BarCode Value: {result.getExtended().getOneD().getValue()}")
    print(f"BarCode Checksum: {result.getExtended().getOneD().getCheckSum()}")

generator = Generation.BarcodeGenerator(Generation.EncodeTypes.EAN_13, "1234567890128")
generator.save(self.image_path_to_save, Generation.BarCodeImageFormat.PNG)
reader = Recognition.BarCodeReader(self.image_path_to_save, None,Recognition.DecodeType.EAN_13)
# checksum enabled
reader.getBarcodeSettings().setChecksumValidation(Recognition.ChecksumValidation.ON)
results = reader.readBarCodes()
for result in results:
    print(f"\nBarCode Type: {result.getCodeTypeName()}")
    print(f"BarCode CodeText: {result.getCodeText()}")
    print(f"BarCode Value: {result.getExtended().getOneD().getValue()}")
    print(f"BarCode Checksum: {result.getExtended().getOneD().getCheckSum()}")

Returns

:Enable checksum validation during recognition for 1D and Postal barcodes.

setDetectEncoding()

def setDetectEncoding	(		self,
			value
	)

The flag which force engine to detect codetext encoding for Unicode codesets.

Default value is true. Example

generator = Generation.BarcodeGenerator(Generation.EncodeTypes.QR, "Слово")
im = generator.generateBarCodeImage()
# detects encoding for Unicode codesets is enabled
reader = Recognition.BarCodeReader(im, None,Recognition.DecodeType.QR)
reader.getBarcodeSettings().setDetectEncoding(True)
results = reader.readBarCodes()
for result in results:
    print(f"\nBarCode Type: {result.getCodeTypeName()}")
    print(f"BarCode CodeText: {result.getCodeText()}")

# detect encoding is disabled
 generator = Generation.BarcodeGenerator(Generation.EncodeTypes.QR, "Слово")
 im = generator.generateBarCodeImage()
 # detects encoding for Unicode codesets is enabled
 reader = Recognition.BarCodeReader(im, None,Recognition.DecodeType.QR)
 reader.getBarcodeSettings().setDetectEncoding(False)
 results = reader.readBarCodes()
 for result in results:
     print(f"\nBarCode Type: {result.getCodeTypeName()}")
     print(f"BarCode CodeText: {result.getCodeText()}")

Parameters

value: The flag which force engine to detect codetext encoding for Unicode codesets

setStripFNC()

def setStripFNC	(		self,
			value
	)

Strip FNC1, FNC2, FNC3 characters from codetext.

Default value is false. Example

generator = Generation.BarcodeGenerator(Generation.EncodeTypes.GS_1_CODE_128, "(02)04006664241007(37)1(400)7019590754")
generator.save(self.image_path_to_save, Generation.BarCodeImageFormat.PNG)
reader = Recognition.BarCodeReader(self.image_path_to_save,None,Recognition.DecodeType.CODE_128)
# StripFNC disabled
reader.getBarcodeSettings().setStripFNC(False)
results = reader.readBarCodes()
for result in results:
    print(f"\nBarCode Type: {result.getCodeTypeName()}")
    print(f"BarCode CodeText: {result.getCodeText()}")

reader = Recognition.BarCodeReader(self.image_path_to_save,None,Recognition.DecodeType.CODE_128)
# StripFNC enabled
reader.getBarcodeSettings().setStripFNC(False)
results = reader.readBarCodes()
for result in results:
      print(f"\nBarCode Type: {result.getCodeTypeName()}")
      print(f"BarCode CodeText: {result.getCodeText()}")

Returns

: Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.