MaxiCodeStructuredCodetext Class Reference

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

Inherits MaxiCodeCodetext.

Inherited by MaxiCodeCodetextMode2, and MaxiCodeCodetextMode3.

Public Member Functions
None	__init__ (self, javaClass)
bool	equals (self, MaxiCodeStructuredCodetext obj)
	Returns a value indicating whether this instance is equal to a specified MaxiCodeStructuredCodetext value. More...
str	getConstructedCodetext (self)
	Constructs codetext. More...
int	getCountryCode (self)
	Identifies 3 digit country code. More...
int	getHashCode (self)
	Returns the hash code for this instance. More...
str	getPostalCode (self)
	Identifies the postal code. More...
Optional[MaxiCodeSecondMessage]	getSecondMessage (self)
	Identifies second message of the barcode. More...
int	getServiceCategory (self)
	Identifies 3 digit service category. More...
None	init (self)
None	initFromString (self, str constructedCodetext)
	Initializes instance from constructed codetext. More...
None	setCountryCode (self, int value)
	Identifies 3 digit country code. More...
None	setPostalCode (self, str value)
	Identifies the postal code. More...
None	setSecondMessage (self, MaxiCodeSecondMessage value)
	Identifies second message of the barcode. More...
None	setServiceCategory (self, int value)
	Identifies 3 digit service category. More...
Public Member Functions inherited from MaxiCodeCodetext
int	getBarcodeType (self)
	Gets barcode type. More...
int	getECIEncoding (self)
	Gets ECI encoding. More...
Generation.MaxiCodeEncodeMode	getMaxiCodeEncodeMode (self)
	Gets a MaxiCode encode mode. More...
Optional[Generation.MaxiCodeMode]	getMode (self)
	Gets MaxiCode mode. More...
None	setECIEncoding (self, int value)
	Sets ECI encoding. More...
None	setMaxiCodeEncodeMode (self, Generation.MaxiCodeEncodeMode value)
	Sets a MaxiCode encode mode. More...
Public Member Functions inherited from BaseJavaClass
def	getJavaClass (self)
str	getJavaClassName (self)
bool	isNull (self)
None	printJavaClassName (self)
None	setJavaClass (self, javaClass)

Public Attributes
	maxiCodeSecondMessage
Public Attributes inherited from BaseJavaClass
	javaClass
	javaClassName

Static Public Attributes
string	JAVA_CLASS_NAME = "com.aspose.mw.barcode.complexbarcode.MwMaxiCodeStructuredCodetext"

Detailed Description

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

 This sample shows how to decode raw MaxiCode codetext to MaxiCodeStructuredCodetext instance.
 \code

 reader = Recognition.BarCodeReader(
     imagePath, None, DecodeType.MAXI_CODE)
 for result in reader.readBarCodes():
    resultMaxiCodeCodetext = ComplexCodetextReader.tryDecodeMaxiCode(
        result.getExtended().getMaxiCode().getMaxiCodeMode(), result.getCodeText())
    if resultMaxiCodeCodetext is MaxiCodeStructuredCodetext:
        maxiCodeStructuredCodetext = resultMaxiCodeCodetext
        print("BarCode Type: " + maxiCodeStructuredCodetext.getPostalCode())
        print("MaxiCode mode: " + \
              maxiCodeStructuredCodetext.getCountryCode())
        print("BarCode CodeText: " + \
              maxiCodeStructuredCodetext.getServiceCategory())
 \endcode

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
			javaClass
	)

Reimplemented from IComplexCodetext.

Member Function Documentation

equals()

bool equals	(		self,
		MaxiCodeStructuredCodetext	obj
	)

Returns a value indicating whether this instance is equal to a specified MaxiCodeStructuredCodetext value.

Parameters

obj:An MaxiCodeStructuredCodetext value to compare to this instance.

Returns

:True if obj has the same value as this instance; otherwise, False.

getConstructedCodetext()

str getConstructedCodetext

(

self

)

Constructs codetext.

Returns

:Constructed codetext

Reimplemented from IComplexCodetext.

getCountryCode()

int getCountryCode

(

self

)

Identifies 3 digit country code.

getHashCode()

int getHashCode

(

self

)

Returns the hash code for this instance.

Returns

: A 32-bit signed integer hash code.

getPostalCode()

str getPostalCode

(

self

)

Identifies the postal code.

Must be 9 digits in mode 2 or 6 alphanumeric symbols in mode 3.

getSecondMessage()

Optional[MaxiCodeSecondMessage] getSecondMessage

(

self

)

Identifies second message of the barcode.

getServiceCategory()

int getServiceCategory

(

self

)

Identifies 3 digit service category.

init()

None init

(

self

)

Reimplemented from BaseJavaClass.

Reimplemented in MaxiCodeCodetextMode3, and MaxiCodeCodetextMode2.

initFromString()

None initFromString	(		self,
		str	constructedCodetext
	)

Initializes instance from constructed codetext.

Parameters

constructedCodetext:Constructed codetext.

Reimplemented from IComplexCodetext.

setCountryCode()

None setCountryCode	(		self,
		int	value
	)

Identifies 3 digit country code.

setPostalCode()

None setPostalCode	(		self,
		str	value
	)

Identifies the postal code.

Must be 9 digits in mode 2 or 6 alphanumeric symbols in mode 3.

setSecondMessage()

None setSecondMessage	(		self,
		MaxiCodeSecondMessage	value
	)

Identifies second message of the barcode.

setServiceCategory()

None setServiceCategory	(		self,
		int	value
	)

Identifies 3 digit service category.

Member Data Documentation

JAVA_CLASS_NAME

string JAVA_CLASS_NAME = "com.aspose.mw.barcode.complexbarcode.MwMaxiCodeStructuredCodetext"

static

maxiCodeSecondMessage

maxiCodeSecondMessage