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)
 
def init (self)
 
def getMacroPdf417FileID (self)
 Gets the file ID of the barcode, only available with MacroPdf417.Value: The file ID for MacroPdf417. More...
 
def getMacroPdf417SegmentID (self)
 Gets the segment ID of the barcode,only available with MacroPdf417.Value: The segment ID of the barcode. More...
 
def getMacroPdf417SegmentsCount (self)
 Gets macro pdf417 barcode segments count. More...
 
def getMacroPdf417FileName (self)
 Macro PDF417 file name (optional). More...
 
def getMacroPdf417FileSize (self)
 Macro PDF417 file size (optional). More...
 
def getMacroPdf417Sender (self)
 Macro PDF417 sender name (optional). More...
 
def getMacroPdf417Addressee (self)
 Macro PDF417 addressee name (optional). More...
 
def getMacroPdf417TimeStamp (self)
 Macro PDF417 time stamp (optional). More...
 
def getMacroPdf417Checksum (self)
 Macro PDF417 checksum (optional). More...
 
def isReaderInitialization (self)
 Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. More...
 
def isLinked (self)
 Flag that indicates that the barcode must be linked to 1D barcode. More...
 
def isCode128Emulation (self)
 Flag that indicates that the MicroPdf417 barcode encoded with 908, 909, 910 or 911 Code 128 emulation codewords. More...
 
def getMacroPdf417Terminator (self)
 Indicates whether the segment is the last segment of a Macro PDF417 file. More...
 
def equals (self, obj)
 Returns a value indicating whether this instance is equal to a specified Pdf417ExtendedParameters value. More...
 
def hashCode (self)
 Returns the hash code for this instance. More...
 
def toString (self)
 Returns a human-readable string representation of this Pdf417ExtendedParameters. More...
 
- Public Member Functions inherited from BaseJavaClass
def getJavaClass (self)
 
def setJavaClass (self, javaClass)
 
def getJavaClassName (self)
 
def isNull (self)
 
def printJavaClassName (self)
 

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 = BarcodeGenerator(EncodeTypes.MacroPdf417, "12345")
generator.getParameters().getBarcode().getPdf417().setPdf417MacroFileID(10)
generator.getParameters().getBarcode().getPdf417().setPdf417MacroSegmentsCount(2)
generator.getParameters().getBarcode().getPdf417().setPdf417MacroSegmentID(1)
generator.save("test.png", BarCodeImageFormat.PNG)
reader = Recognition.BarCodeReader("test.png", None, 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: " + result.getExtended().getPdf417().getMacroPdf417SegmentsCount())
print("Macro Pdf417 SegmentID: " + result.getExtended().getPdf417().getMacroPdf417SegmentID())

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  javaClass 
)

Reimplemented from BaseJavaClass.

Member Function Documentation

◆ equals()

def equals (   self,
  obj 
)

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

Parameters
obj An System.Object value to compare to this instance.
Returns
: true if obj has the same value as this instance otherwise, false.

◆ getMacroPdf417Addressee()

def getMacroPdf417Addressee (   self)

Macro PDF417 addressee name (optional).

Returns
: Addressee name.

◆ getMacroPdf417Checksum()

def getMacroPdf417Checksum (   self)

Macro PDF417 checksum (optional).

Returns
: Checksum.

◆ getMacroPdf417FileID()

def getMacroPdf417FileID (   self)

Gets the file ID of the barcode, only available with MacroPdf417.Value: The file ID for MacroPdf417.

◆ getMacroPdf417FileName()

def getMacroPdf417FileName (   self)

Macro PDF417 file name (optional).

Returns
: File name.

◆ getMacroPdf417FileSize()

def getMacroPdf417FileSize (   self)

Macro PDF417 file size (optional).

Returns
: File size.

◆ getMacroPdf417SegmentID()

def getMacroPdf417SegmentID (   self)

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

◆ getMacroPdf417SegmentsCount()

def getMacroPdf417SegmentsCount (   self)

Gets macro pdf417 barcode segments count.

Default value is -1.Value: Segments count.

◆ getMacroPdf417Sender()

def getMacroPdf417Sender (   self)

Macro PDF417 sender name (optional).

Returns
: Sender name

◆ getMacroPdf417Terminator()

def getMacroPdf417Terminator (   self)

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

Returns
Terminator.

◆ getMacroPdf417TimeStamp()

def getMacroPdf417TimeStamp (   self)

Macro PDF417 time stamp (optional).

Returns
: Time stamp.

◆ hashCode()

def hashCode (   self)

Returns the hash code for this instance.

Returns
: A 32-bit signed integer hash code.

◆ init()

def init (   self)

Reimplemented from BaseJavaClass.

◆ isCode128Emulation()

def 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()

def isLinked (   self)

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

Returns
Linkage flag

◆ isReaderInitialization()

def isReaderInitialization (   self)

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

:

Returns
: Reader initialization flag

◆ toString()

def toString (   self)

Returns a human-readable string representation of this Pdf417ExtendedParameters.

Returns
: A string that represents this Pdf417ExtendedParameters.