Aspose.BarCode for Python via Java  24.11
Aspose.Barcode for Python via Java Generation and Recognition API docs
MaxiCodeCodetext Class Reference

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

Inherits IComplexCodetext.

Inherited by MaxiCodeStandardCodetext, and MaxiCodeStructuredCodetext.

Public Member Functions

Generation.EncodeTypes getBarcodeType (self)
 Gets barcode type. More...
 
Generation.ECIEncodings getECIEncoding (self)
 Gets ECI encoding. More...
 
Generation.MaxiCodeEncodeMode getMaxiCodeEncodeMode (self)
 Gets a MaxiCode encode mode. More...
 
Optional[Generation.MaxiCodeModegetMode (self)
 Gets MaxiCode mode. More...
 
None setECIEncoding (self, Generation.ECIEncodings eciEncodings)
 Sets ECI encoding. More...
 
None setMaxiCodeEncodeMode (self, Generation.MaxiCodeEncodeMode value)
 Sets a MaxiCode encode mode. More...
 
- Public Member Functions inherited from IComplexCodetext
def __init__ (self, javaClass)
 
Optional[str] getConstructedCodetext (self)
 Construct codetext for complex barcode. More...
 
None initFromString (self, str constructedCodetext)
 Initializes instance with constructed codetext. More...
 
- Public Member Functions inherited from BaseJavaClass
def getJavaClass (self)
 
str getJavaClassName (self)
 
None init (self)
 
bool isNull (self)
 
None printJavaClassName (self)
 
None setJavaClass (self, javaClass)
 

Additional Inherited Members

- Public Attributes inherited from BaseJavaClass
 javaClass
 
 javaClassName
 

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 = Recognition.BarCodeReader(imagePath, None, Recognition.DecodeType.MAXI_CODE)
for result in reader.readBarCodes():
resultMaxiCodeCodetext = ComplexBarcode.ComplexCodetextReader.tryDecodeMaxiCode(
result.getExtended().getMaxiCode().getMaxiCodeMode(), result.getCodeText())
print("BarCode Type: " + str(resultMaxiCodeCodetext.getBarcodeType()))
print("MaxiCode mode: " + str(resultMaxiCodeCodetext.getMode()))

Member Function Documentation

◆ getBarcodeType()

Generation.EncodeTypes getBarcodeType (   self)

Gets barcode type.

Returns
: Barcode type.

Reimplemented from IComplexCodetext.

◆ getECIEncoding()

Generation.ECIEncodings getECIEncoding (   self)

Gets ECI encoding.

Used when MaxiCodeEncodeMode is AUTO.

◆ getMaxiCodeEncodeMode()

Generation.MaxiCodeEncodeMode getMaxiCodeEncodeMode (   self)

Gets a MaxiCode encode mode.

◆ getMode()

Optional[Generation.MaxiCodeMode] getMode (   self)

Gets MaxiCode mode.

Returns
: MaxiCode mode or None if not set.

Reimplemented in MaxiCodeCodetextMode3, MaxiCodeCodetextMode2, and MaxiCodeStandardCodetext.

◆ setECIEncoding()

None setECIEncoding (   self,
Generation.ECIEncodings  eciEncodings 
)

Sets ECI encoding.

Used when MaxiCodeEncodeMode is AUTO.

◆ setMaxiCodeEncodeMode()

None setMaxiCodeEncodeMode (   self,
Generation.MaxiCodeEncodeMode  value 
)

Sets a MaxiCode encode mode.