Base class for encoding and decoding the text embedded in the MaxiCode code. More...

Inherited by MaxiCodeStandardCodetext, and MaxiCodeStructuredCodetext.

Public Member Functions
EncodeTypes	barcode_type (self)
	Gets barcode type. More...

ECIEncodings	eci_encoding (self)
	Gets ECI encoding. More...

None	eci_encoding (self, ECIEncodings value)
	Sets ECI encoding. More...

MaxiCodeEncodeMode	encode_mode (self)

None	encode_mode (self, MaxiCodeEncodeMode value)

MaxiCodeEncodeMode	maxi_code_encode_mode (self)
	Gets a MaxiCode encode mode. More...

None	maxi_code_encode_mode (self, MaxiCodeEncodeMode value)
	Sets a MaxiCode encode mode. More...

Optional[MaxiCodeMode]	mode (self)
	Gets MaxiCode mode. More...

Public Member Functions inherited from IComplexCodetext
def	__init__ (self, _java_class)

Optional[str]	constructed_codetext (self)
	Construct codetext for complex barcode. More...

None	init_from_string (self, str constructed_codetext)
	Initializes instance with constructed codetext. More...

Detailed Description

Base class for encoding and decoding the text embedded in the MaxiCode code.

This sample shows how to decode raw MaxiCode codetext to MaxiCodeCodetext instance.

reader = BarCodeReader(image_path, DecodeType.MAXI_CODE)
 
for result in reader.read_barcodes():
    maxi_code_codetext = ComplexCodetextReader.try_decode_maxi_code(result.extended.maxi_code.mode, result.code_text)
    print("BarCode Type:", maxi_code_codetext.barcode_type)
    print("MaxiCode mode:", maxi_code_codetext.mode)

Member Function Documentation

◆ barcode_type()

EncodeTypes barcode_type ( self )

Gets barcode type.

Returns: : Barcode type.

Reimplemented from IComplexCodetext.

◆ eci_encoding() [1/2]

ECIEncodings eci_encoding ( self )

Gets ECI encoding.

Used when MaxiCodeEncodeMode is AUTO.

◆ eci_encoding() [2/2]

None eci_encoding	(		self,
		ECIEncodings	value
	)

Sets ECI encoding.

Used when MaxiCodeEncodeMode is AUTO.

◆ encode_mode() [1/2]

MaxiCodeEncodeMode encode_mode ( self )

Gets a MaxiCode encode mode.
Default value: Auto.

:return: A MaxiCode encode mode.

◆ encode_mode() [2/2]

None encode_mode	(		self,
		MaxiCodeEncodeMode	value
	)

Sets a MaxiCode encode mode.
Default value: Auto.

:param value: A MaxiCode encode mode.

◆ maxi_code_encode_mode() [1/2]

MaxiCodeEncodeMode maxi_code_encode_mode ( self )

Gets a MaxiCode encode mode.

◆ maxi_code_encode_mode() [2/2]

None maxi_code_encode_mode	(		self,
		MaxiCodeEncodeMode	value
	)

Sets a MaxiCode encode mode.

◆ mode()

Optional[MaxiCodeMode] mode ( self )

Gets MaxiCode mode.

Returns: : MaxiCode mode or None if not set.

Reimplemented in MaxiCodeStandardCodetext, MaxiCodeCodetextMode3, and MaxiCodeCodetextMode2.

Public Member Functions