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

PDF417 parameters. More...

Inherits BaseJavaClass.

Public Member Functions

None __init__ (self, javaClass)
 
str __str__ (self)
 Returns a human-readable string representation of this Pdf417Parameters. More...
 
float getAspectRatio (self)
 Height/Width ratio of 2D BarCode module. More...
 
int getColumns (self)
 Columns count. More...
 
int getMacroCharacters (self)
 Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. More...
 
Pdf417CompactionMode getPdf417CompactionMode (self)
 Pdf417 symbology type of BarCode's compaction mode. More...
 
int getPdf417ECIEncoding (self)
 Extended Channel Interpretation Identifiers. More...
 
Pdf417EncodeMode getPdf417EncodeMode (self)
 Gets Pdf417 encode mode. More...
 
Pdf417ErrorLevel getPdf417ErrorLevel (self)
 Gets Pdf417 symbology type of BarCode's error correction level. More...
 
str getPdf417MacroAddressee (self)
 Gets macro Pdf417 barcode addressee name. More...
 
int getPdf417MacroChecksum (self)
 Gets macro Pdf417 barcode checksum. More...
 
int getPdf417MacroECIEncoding (self)
 Extended Channel Interpretation Identifiers. More...
 
int getPdf417MacroFileID (self)
 Gets macro Pdf417 barcode's file ID. More...
 
str getPdf417MacroFileName (self)
 Gets macro Pdf417 barcode file name. More...
 
int getPdf417MacroFileSize (self)
 Gets macro Pdf417 file size. More...
 
int getPdf417MacroSegmentID (self)
 Gets macro Pdf417 barcode's segment ID. More...
 
int getPdf417MacroSegmentsCount (self)
 Gets macro Pdf417 barcode segments count. More...
 
str getPdf417MacroSender (self)
 Gets macro Pdf417 barcode sender name. More...
 
int getPdf417MacroTerminator (self)
 Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. More...
 
datetime getPdf417MacroTimeStamp (self)
 Gets macro Pdf417 barcode time stamp. More...
 
bool getPdf417Truncate (self)
 Whether Pdf417 symbology type of BarCode is truncated (to reduce space). More...
 
int getRows (self)
 Rows count. More...
 
None init (self)
 
bool isCode128Emulation (self)
 Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128. More...
 
bool isLinked (self)
 Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC. More...
 
bool isReaderInitialization (self)
 Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. More...
 
None setAspectRatio (self, float value)
 Height/Width ratio of 2D BarCode module. More...
 
None setCode128Emulation (self, bool value)
 Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128. More...
 
None setColumns (self, int value)
 Columns count. More...
 
None setLinked (self, bool value)
 Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC. More...
 
None setMacroCharacters (self, int value)
 Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. More...
 
None setPdf417CompactionMode (self, Pdf417CompactionMode value)
 Pdf417 symbology type of BarCode's compaction mode. More...
 
None setPdf417ECIEncoding (self, int pdf417ECIEncoding)
 Extended Channel Interpretation Identifiers. More...
 
None setPdf417EncodeMode (self, Pdf417EncodeMode value)
 Sets Pdf417 encode mode. More...
 
None setPdf417ErrorLevel (self, Pdf417ErrorLevel value)
 Sets Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means the best error correction which means a larger picture. More...
 
None setPdf417MacroAddressee (self, str value)
 Sets macro Pdf417 barcode addressee name. More...
 
None setPdf417MacroChecksum (self, int value)
 Sets macro Pdf417 barcode checksum. More...
 
None setPdf417MacroECIEncoding (self, int pdf417MacroECIEncoding)
 Extended Channel Interpretation Identifiers. More...
 
None setPdf417MacroFileID (self, int value)
 Sets macro Pdf417 barcode's file ID. More...
 
None setPdf417MacroFileName (self, str value)
 Sets macro Pdf417 barcode file name. More...
 
None setPdf417MacroFileSize (self, int value)
 Sets macro Pdf417 file size. More...
 
None setPdf417MacroSegmentID (self, int value)
 Sets macro Pdf417 barcode's segment ID. More...
 
None setPdf417MacroSegmentsCount (self, int value)
 Sets macro Pdf417 barcode segments count. More...
 
None setPdf417MacroSender (self, str value)
 Sets macro Pdf417 barcode sender name. More...
 
None setPdf417MacroTerminator (self, int pdf417MacroTerminator)
 Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. More...
 
None setPdf417MacroTimeStamp (self, datetime value)
 Sets macro Pdf417 barcode time stamp. More...
 
None setPdf417Truncate (self, bool value)
 Whether Pdf417 symbology type of BarCode is truncated. More...
 
None setReaderInitialization (self, bool readerInitialization)
 Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. More...
 
None setRows (self, int value)
 Rows count. 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

PDF417 parameters.

Contains PDF417, MacroPDF417, MicroPDF417 and GS1MicroPdf417 parameters. MacroPDF417 requires two fields: Pdf417MacroFileID and Pdf417MacroSegmentID. All other fields are optional. MicroPDF417 in Structured Append mode (same as MacroPDF417 mode) requires two fields: Pdf417MacroFileID and Pdf417MacroSegmentID. All other fields are optional. These samples show how to encode UCC/EAN-128 non Linked modes in GS1MicroPdf417

# Encodes GS1 UCC/EAN-128 non Linked mode 905 with AI 01 (GTIN)
generator = Generation.BarcodeGenerator(Generation.EncodeTypes.GS_1_MICRO_PDF_417, "(01)12345678901231")
reader = Recognition.BarCodeReader(generator.generateBarCodeImage(), None, Recognition.DecodeType.GS_1_MICRO_PDF_417)
results = reader.readBarCodes()
for result in results:
print(f"\nBarCode Type: {result.getCodeTypeName()}")
print(f"BarCode CodeText: {result.getCodeText()}")
# Encodes GS1 UCC/EAN-128 non Linked modes 903, 904 with any AI
generator = Generation.BarcodeGenerator(Generation.EncodeTypes.GS_1_MICRO_PDF_417, "(241)123456789012345(241)ABCD123456789012345")
reader = Recognition.BarCodeReader(generator.generateBarCodeImage(), None, Recognition.DecodeType.GS_1_MICRO_PDF_417)
results = reader.readBarCodes()
for result in results:
print(f"\nBarCode Type: {result.getCodeTypeName()}")
print(f"BarCode CodeText: {result.getCodeText()}")

Constructor & Destructor Documentation

◆ __init__()

None __init__ (   self,
  javaClass 
)

Reimplemented from BaseJavaClass.

Member Function Documentation

◆ __str__()

str __str__ (   self)

Returns a human-readable string representation of this Pdf417Parameters.

Returns
string that represents this Pdf417Parameters.

◆ getAspectRatio()

float getAspectRatio (   self)

Height/Width ratio of 2D BarCode module.

◆ getColumns()

int getColumns (   self)

Columns count.

◆ getMacroCharacters()

int getMacroCharacters (   self)

Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes.

Can be used only with MicroPdf417 and encodes 916 and 917 MicroPdf417 modes Default value: MacroCharacters.None.

Returns
MacroCharacters int value

◆ getPdf417CompactionMode()

Pdf417CompactionMode getPdf417CompactionMode (   self)

Pdf417 symbology type of BarCode's compaction mode.

Default value: Pdf417CompactionMode.AUTO.

◆ getPdf417ECIEncoding()

int getPdf417ECIEncoding (   self)

Extended Channel Interpretation Identifiers.

It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Current implementation consists all well known charset encodings.

Returns
pdf417ECIEncoding int value

◆ getPdf417EncodeMode()

Pdf417EncodeMode getPdf417EncodeMode (   self)

Gets Pdf417 encode mode.

Default value: Auto.

Returns
Pdf417EncodeMode

◆ getPdf417ErrorLevel()

Pdf417ErrorLevel getPdf417ErrorLevel (   self)

Gets Pdf417 symbology type of BarCode's error correction level.

◆ getPdf417MacroAddressee()

str getPdf417MacroAddressee (   self)

Gets macro Pdf417 barcode addressee name.

◆ getPdf417MacroChecksum()

int getPdf417MacroChecksum (   self)

Gets macro Pdf417 barcode checksum.

Returns
The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial.

◆ getPdf417MacroECIEncoding()

int getPdf417MacroECIEncoding (   self)

Extended Channel Interpretation Identifiers.

Applies for Macro PDF417 text fields.

Returns
pdf417MacroECIEncoding int value

◆ getPdf417MacroFileID()

int getPdf417MacroFileID (   self)

Gets macro Pdf417 barcode's file ID.

Used for MacroPdf417.

◆ getPdf417MacroFileName()

str getPdf417MacroFileName (   self)

Gets macro Pdf417 barcode file name.

◆ getPdf417MacroFileSize()

int getPdf417MacroFileSize (   self)

Gets macro Pdf417 file size.

Returns
The file size field contains the size in bytes of the entire source file.

◆ getPdf417MacroSegmentID()

int getPdf417MacroSegmentID (   self)

Gets macro Pdf417 barcode's segment ID.

◆ getPdf417MacroSegmentsCount()

int getPdf417MacroSegmentsCount (   self)

Gets macro Pdf417 barcode segments count.

◆ getPdf417MacroSender()

str getPdf417MacroSender (   self)

Gets macro Pdf417 barcode sender name.

◆ getPdf417MacroTerminator()

int getPdf417MacroTerminator (   self)

Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment.

Applied only for Macro PDF417.

Returns
Pdf417MacroTerminator int value

◆ getPdf417MacroTimeStamp()

datetime getPdf417MacroTimeStamp (   self)

Gets macro Pdf417 barcode time stamp.

◆ getPdf417Truncate()

bool getPdf417Truncate (   self)

Whether Pdf417 symbology type of BarCode is truncated (to reduce space).

◆ getRows()

int getRows (   self)

Rows count.

◆ init()

None init (   self)

Reimplemented from BaseJavaClass.

◆ isCode128Emulation()

bool isCode128Emulation (   self)

Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128.

Returns
boolean value

◆ isLinked()

bool isLinked (   self)

Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC.

Returns
boolean value

◆ isReaderInitialization()

bool isReaderInitialization (   self)

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

Returns
readerInitialization boolean value

◆ setAspectRatio()

None setAspectRatio (   self,
float  value 
)

Height/Width ratio of 2D BarCode module.

◆ setCode128Emulation()

None setCode128Emulation (   self,
bool  value 
)

Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128.

Parameters
booleanvalue

◆ setColumns()

None setColumns (   self,
int  value 
)

Columns count.

◆ setLinked()

None setLinked (   self,
bool  value 
)

Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC.

Parameters
booleanvalue

◆ setMacroCharacters()

None setMacroCharacters (   self,
int  value 
)

Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes.

Can be used only with MicroPdf417 and encodes 916 and 917 MicroPdf417 modes Default value: MacroCharacters.None.

Parameters
MacroCharactersint value

◆ setPdf417CompactionMode()

None setPdf417CompactionMode (   self,
Pdf417CompactionMode  value 
)

Pdf417 symbology type of BarCode's compaction mode.

Default value: Pdf417CompactionMode.AUTO.

◆ setPdf417ECIEncoding()

None setPdf417ECIEncoding (   self,
int  pdf417ECIEncoding 
)

Extended Channel Interpretation Identifiers.

It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Current implementation consists all well known charset encodings.

Parameters
pdf417ECIEncodingint value

◆ setPdf417EncodeMode()

None setPdf417EncodeMode (   self,
Pdf417EncodeMode  value 
)

Sets Pdf417 encode mode.

Default value: Auto.

Parameters
Pdf417EncodeMode

◆ setPdf417ErrorLevel()

None setPdf417ErrorLevel (   self,
Pdf417ErrorLevel  value 
)

Sets Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means the best error correction which means a larger picture.

◆ setPdf417MacroAddressee()

None setPdf417MacroAddressee (   self,
str  value 
)

Sets macro Pdf417 barcode addressee name.

◆ setPdf417MacroChecksum()

None setPdf417MacroChecksum (   self,
int  value 
)

Sets macro Pdf417 barcode checksum.

Parameters
valueThe checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial.

◆ setPdf417MacroECIEncoding()

None setPdf417MacroECIEncoding (   self,
int  pdf417MacroECIEncoding 
)

Extended Channel Interpretation Identifiers.

Applies for Macro PDF417 text fields.

Parameters
pdf417MacroECIEncodingint value

◆ setPdf417MacroFileID()

None setPdf417MacroFileID (   self,
int  value 
)

Sets macro Pdf417 barcode's file ID.

Used for MacroPdf417.

◆ setPdf417MacroFileName()

None setPdf417MacroFileName (   self,
str  value 
)

Sets macro Pdf417 barcode file name.

◆ setPdf417MacroFileSize()

None setPdf417MacroFileSize (   self,
int  value 
)

Sets macro Pdf417 file size.

Parameters
valueThe file size field contains the size in bytes of the entire source file.

◆ setPdf417MacroSegmentID()

None setPdf417MacroSegmentID (   self,
int  value 
)

Sets macro Pdf417 barcode's segment ID.

◆ setPdf417MacroSegmentsCount()

None setPdf417MacroSegmentsCount (   self,
int  value 
)

Sets macro Pdf417 barcode segments count.

◆ setPdf417MacroSender()

None setPdf417MacroSender (   self,
str  value 
)

Sets macro Pdf417 barcode sender name.

◆ setPdf417MacroTerminator()

None setPdf417MacroTerminator (   self,
int  pdf417MacroTerminator 
)

Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment.

Applied only for Macro PDF417.

Parameters
Pdf417MacroTerminatorint value

◆ setPdf417MacroTimeStamp()

None setPdf417MacroTimeStamp (   self,
datetime  value 
)

Sets macro Pdf417 barcode time stamp.

◆ setPdf417Truncate()

None setPdf417Truncate (   self,
bool  value 
)

Whether Pdf417 symbology type of BarCode is truncated.

◆ setReaderInitialization()

None setReaderInitialization (   self,
bool  readerInitialization 
)

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

Parameters
readerInitializationboolean value

◆ setRows()

None setRows (   self,
int  value 
)

Rows count.