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

Stores a MacroPdf417 metadata information of recognized barcode. More...

Inherits BaseJavaClass.

Public Member Functions

def __init__ (self, javaClass)
 
bool __eq__ (self, Pdf417ExtendedParameters other)
 Returns a value indicating whether this instance is equal to a specified Pdf417ExtendedParameters value. More...
 
int __hash__ (self)
 Returns the hash code for the current instance. More...
 
str __str__ (self)
 Returns a human-readable string representation of this Pdf417ExtendedParameters. More...
 
Optional[str] getMacroPdf417Addressee (self)
 Macro PDF417 addressee name (optional). More...
 
Optional[int] getMacroPdf417Checksum (self)
 Macro PDF417 checksum (optional). More...
 
str getMacroPdf417FileID (self)
 Gets the file ID of the barcode, only available with MacroPdf417. More...
 
Optional[str] getMacroPdf417FileName (self)
 Macro PDF417 file name (optional). More...
 
Optional[int] getMacroPdf417FileSize (self)
 Macro PDF417 file size (optional). More...
 
int getMacroPdf417SegmentID (self)
 Gets the segment ID of the barcode, only available with MacroPdf417. More...
 
int getMacroPdf417SegmentsCount (self)
 Gets macro pdf417 barcode segments count. More...
 
Optional[str] getMacroPdf417Sender (self)
 Macro PDF417 sender name (optional). More...
 
bool getMacroPdf417Terminator (self)
 Indicates whether the segment is the last segment of a Macro PDF417 file. More...
 
Optional[datetime] getMacroPdf417TimeStamp (self)
 Macro PDF417 time stamp (optional). More...
 
None init (self)
 
bool isCode128Emulation (self)
 Flag that indicates that the MicroPdf417 barcode encoded with 908, 909, 910 or 911 Code 128 emulation codewords. More...
 
bool isLinked (self)
 Flag that indicates that the barcode must be linked to a 1D barcode. More...
 
bool isReaderInitialization (self)
 Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. More...
 
- Public Member Functions inherited from BaseJavaClass
def getJavaClass (self)
 
str getJavaClassName (self)
 
bool isNull (self)
 
None printJavaClassName (self)
 
None setJavaClass (self, javaClass)
 

Additional Inherited Members

- Public Attributes inherited from BaseJavaClass
 javaClass
 
 javaClassName
 

Detailed Description

Stores a MacroPdf417 metadata information of recognized barcode.

This sample shows how to get Macro Pdf417 metadata

generator = Generation.BarcodeGenerator(Generation.EncodeTypes.MACRO_PDF_417, "12345")
generator.getParameters().getBarcode().getPdf417().setPdf417MacroFileID(10)
generator.getParameters().getBarcode().getPdf417().setPdf417MacroSegmentsCount(2)
generator.getParameters().getBarcode().getPdf417().setPdf417MacroSegmentID(1)
generator.save(self.image_path_to_save, Generation.BarCodeImageFormat.PNG)
reader = Recognition.BarCodeReader(self.image_path_to_save, None, Recognition.DecodeType.MACRO_PDF_417)
for result in reader.readBarCodes():
print("BarCode Type: " + result.getCodeTypeName())
print("BarCode CodeText: " + result.getCodeText())
print("Macro Pdf417 FileID: " + result.getExtended().getPdf417().getMacroPdf417FileID())
print("Macro Pdf417 Segments: " + str(result.getExtended().getPdf417().getMacroPdf417SegmentsCount()))
print("Macro Pdf417 SegmentID: " + str(result.getExtended().getPdf417().getMacroPdf417SegmentID()))

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  javaClass 
)

Reimplemented from BaseJavaClass.

Member Function Documentation

◆ __eq__()

bool __eq__ (   self,
Pdf417ExtendedParameters  other 
)

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

Parameters
obj An object value to compare to this instance.
Returns
: True if obj has the same value as this instance, otherwise False.

◆ __hash__()

int __hash__ (   self)

Returns the hash code for the current instance.

Returns
A hash code for the current object.

◆ __str__()

str __str__ (   self)

Returns a human-readable string representation of this Pdf417ExtendedParameters.

Returns
: A string that represents this Pdf417ExtendedParameters.

◆ getMacroPdf417Addressee()

Optional[str] getMacroPdf417Addressee (   self)

Macro PDF417 addressee name (optional).

Returns
: Addressee name.

◆ getMacroPdf417Checksum()

Optional[int] getMacroPdf417Checksum (   self)

Macro PDF417 checksum (optional).

Returns
: Checksum.

◆ getMacroPdf417FileID()

str getMacroPdf417FileID (   self)

Gets the file ID of the barcode, only available with MacroPdf417.

Returns
The file ID for MacroPdf417.

◆ getMacroPdf417FileName()

Optional[str] getMacroPdf417FileName (   self)

Macro PDF417 file name (optional).

Returns
: File name.

◆ getMacroPdf417FileSize()

Optional[int] getMacroPdf417FileSize (   self)

Macro PDF417 file size (optional).

Returns
: File size.

◆ getMacroPdf417SegmentID()

int getMacroPdf417SegmentID (   self)

Gets the segment ID of the barcode, only available with MacroPdf417.

Returns
The segment ID of the barcode.

◆ getMacroPdf417SegmentsCount()

int getMacroPdf417SegmentsCount (   self)

Gets macro pdf417 barcode segments count.

Default value is -1.

Returns
: Segments count.

◆ getMacroPdf417Sender()

Optional[str] getMacroPdf417Sender (   self)

Macro PDF417 sender name (optional).

Returns
: Sender name

◆ getMacroPdf417Terminator()

bool getMacroPdf417Terminator (   self)

Indicates whether the segment is the last segment of a Macro PDF417 file.

Returns
: Terminator.

◆ getMacroPdf417TimeStamp()

Optional[datetime] getMacroPdf417TimeStamp (   self)

Macro PDF417 time stamp (optional).

Returns
: Time stamp.

◆ init()

None init (   self)

Reimplemented from BaseJavaClass.

◆ isCode128Emulation()

bool isCode128Emulation (   self)

Flag that indicates that the MicroPdf417 barcode encoded with 908, 909, 910 or 911 Code 128 emulation codewords.

Returns
: Code 128 emulation flag.

◆ isLinked()

bool isLinked (   self)

Flag that indicates that the barcode must be linked to a 1D barcode.

Returns
: Linkage flag.

◆ isReaderInitialization()

bool isReaderInitialization (   self)

Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization.

Returns
: Reader initialization flag.