PDF417 parameters. More...

Inherits _MwWrapper.

Public Member Functions
None	__init__ (self, _java_class)

str	__str__ (self)
	Returns a human-readable string representation of this Pdf417Parameters. More...

float	aspect_ratio (self)
	Height/Width ratio of 2D BarCode module. More...

None	aspect_ratio (self, float value)
	Height/Width ratio of 2D BarCode module. More...

bool	code_128_emulation (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...

None	code_128_emulation (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...

int	columns (self)
	Columns count. More...

None	columns (self, int value)
	Columns count. More...

int	eci_encoding (self)

None	eci_encoding (self, int value)

int	encode_mode (self)

None	encode_mode (self, int value)

Pdf417ErrorLevel	error_level (self)

None	error_level (self, Pdf417ErrorLevel value)

bool	linked (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...

None	linked (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...

int	macro_characters (self)
	Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. More...

None	macro_characters (self, MacroCharacter value)
	Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. More...

Optional[str]	macro_pdf_417_addressee (self)
	Gets macro Pdf417 barcode addressee name. More...

None	macro_pdf_417_addressee (self, str value)
	Sets macro Pdf417 barcode addressee name. More...

int	macro_pdf_417_checksum (self)
	Gets macro Pdf417 barcode checksum. More...

None	macro_pdf_417_checksum (self, int value)
	Sets macro Pdf417 barcode checksum. More...

int	macro_pdf_417_eci_encoding (self)

int	macro_pdf_417_eci_encoding (self)
	Extended Channel Interpretation Identifiers. More...

None	macro_pdf_417_eci_encoding (self, int value)

None	macro_pdf_417_eci_encoding (self, int value)
	Extended Channel Interpretation Identifiers. More...

int	macro_pdf_417_file_id (self)
	Gets macro Pdf417 barcode's file ID. More...

None	macro_pdf_417_file_id (self, int value)
	Sets macro Pdf417 barcode's file ID. More...

Optional[str]	macro_pdf_417_file_name (self)
	Gets macro Pdf417 barcode file name. More...

None	macro_pdf_417_file_name (self, str value)
	Sets macro Pdf417 barcode file name. More...

int	macro_pdf_417_file_size (self)
	Gets macro Pdf417 file size. More...

None	macro_pdf_417_file_size (self, int value)
	Sets macro Pdf417 file size. More...

int	macro_pdf_417_segment_id (self)
	Gets macro Pdf417 barcode's segment ID. More...

None	macro_pdf_417_segment_id (self, int value)
	Sets macro Pdf417 barcode's segment ID. More...

int	macro_pdf_417_segments_count (self)
	Gets macro Pdf417 barcode segments count. More...

None	macro_pdf_417_segments_count (self, int value)
	Sets macro Pdf417 barcode segments count. More...

Optional[str]	macro_pdf_417_sender (self)
	Gets macro Pdf417 barcode sender name. More...

None	macro_pdf_417_sender (self, str value)
	Sets macro Pdf417 barcode sender name. More...

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

None	macro_pdf_417_terminator (self, Pdf417MacroTerminator value)
	Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. More...

datetime	macro_pdf_417_time_stamp (self)
	Gets macro Pdf417 barcode time stamp. More...

None	macro_pdf_417_time_stamp (self, datetime value)
	Sets macro Pdf417 barcode time stamp. More...

Pdf417CompactionMode	pdf_417_compaction_mode (self)
	Pdf417 symbology type of BarCode's compaction mode. More...

None	pdf_417_compaction_mode (self, Pdf417CompactionMode value)
	Pdf417 symbology type of BarCode's compaction mode. More...

int	pdf_417_eci_encoding (self)
	Extended Channel Interpretation Identifiers. More...

None	pdf_417_eci_encoding (self, int pdf417ECIEncoding)
	Extended Channel Interpretation Identifiers. More...

Pdf417EncodeMode	pdf_417_encode_mode (self)
	Gets Pdf417 encode mode. More...

None	pdf_417_encode_mode (self, Pdf417EncodeMode value)
	Sets Pdf417 encode mode. More...

Pdf417ErrorLevel	pdf_417_error_level (self)
	Gets Pdf417 symbology type of BarCode's error correction level. More...

None	pdf_417_error_level (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...

Optional[str]	pdf_417_macro_addressee (self)
	Gets macro Pdf417 barcode addressee name. More...

None	pdf_417_macro_addressee (self, str value)
	Sets macro Pdf417 barcode addressee name. More...

int	pdf_417_macro_checksum (self)
	Gets macro Pdf417 barcode checksum. More...

None	pdf_417_macro_checksum (self, int value)
	Sets macro Pdf417 barcode checksum. More...

int	pdf_417_macro_eci_encoding (self)
	Extended Channel Interpretation Identifiers. More...

None	pdf_417_macro_eci_encoding (self, int pdf417MacroECIEncoding)
	Extended Channel Interpretation Identifiers. More...

int	pdf_417_macro_file_id (self)
	Gets macro Pdf417 barcode's file ID. More...

None	pdf_417_macro_file_id (self, int value)
	Sets macro Pdf417 barcode's file ID. More...

Optional[str]	pdf_417_macro_file_name (self)
	Gets macro Pdf417 barcode file name. More...

None	pdf_417_macro_file_name (self, str value)
	Sets macro Pdf417 barcode file name. More...

int	pdf_417_macro_file_size (self)
	Gets macro Pdf417 file size. More...

None	pdf_417_macro_file_size (self, int value)
	Sets macro Pdf417 file size. More...

int	pdf_417_macro_segment_id (self)
	Gets macro Pdf417 barcode's segment ID. More...

None	pdf_417_macro_segment_id (self, int value)
	Sets macro Pdf417 barcode's segment ID. More...

int	pdf_417_macro_segments_count (self)
	Gets macro Pdf417 barcode segments count. More...

None	pdf_417_macro_segments_count (self, int value)
	Sets macro Pdf417 barcode segments count. More...

Optional[str]	pdf_417_macro_sender (self)
	Gets macro Pdf417 barcode sender name. More...

None	pdf_417_macro_sender (self, str value)
	Sets macro Pdf417 barcode sender name. More...

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

None	pdf_417_macro_terminator (self, int pdf417MacroTerminator)
	Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. More...

datetime	pdf_417_macro_time_stamp (self)
	Gets macro Pdf417 barcode time stamp. More...

None	pdf_417_macro_time_stamp (self, datetime value)
	Sets macro Pdf417 barcode time stamp. More...

bool	pdf_417_truncate (self)
	Whether Pdf417 symbology type of BarCode is truncated (to reduce space). More...

None	pdf_417_truncate (self, bool value)
	Whether Pdf417 symbology type of BarCode is truncated. More...

bool	reader_initialization (self)
	Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. More...

None	reader_initialization (self, bool readerInitialization)
	Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. More...

int	rows (self)
	Rows count. More...

None	rows (self, int value)
	Rows count. More...

int	structured_append_mode_barcode_id (self)

None	structured_append_mode_barcode_id (self, int value)

bool	truncate (self)

None	truncate (self, bool value)

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 = BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(01)12345678901231")
reader = BarCodeReader(generator.generate_barcode_image(), DecodeType.GS_1_MICRO_PDF_417)
results = reader.read_barcodes()
for result in results:
    print(f"\nBarCode Type: {result.code_type_name}")
    print(f"BarCode CodeText: {result.code_text}")

# Encodes GS1 UCC/EAN-128 non Linked modes 903, 904 with any AI
generator = BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(241)123456789012345(241)ABCD123456789012345")
reader = BarCodeReader(generator.generate_barcode_image(), DecodeType.GS_1_MICRO_PDF_417)
results = reader.read_barcodes()
for result in results:
    print(f"\nBarCode Type: {result.code_type_name}")
    print(f"BarCode CodeText: {result.code_text}")

Constructor & Destructor Documentation

◆ init()

None __init__	(	self,
		_java_class
	)

Member Function Documentation

◆ str()

str __str__ ( self )

Returns a human-readable string representation of this Pdf417Parameters.

Returns: string that represents this Pdf417Parameters.

◆ aspect_ratio() [1/2]

float aspect_ratio ( self )

Height/Width ratio of 2D BarCode module.

◆ aspect_ratio() [2/2]

None aspect_ratio	(		self,
		float	value
	)

Height/Width ratio of 2D BarCode module.

◆ code_128_emulation() [1/2]

bool code_128_emulation ( 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

◆ code_128_emulation() [2/2]

None code_128_emulation	(		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

boolean value

◆ columns() [1/2]

int columns ( self )

Columns count.

◆ columns() [2/2]

None columns	(		self,
		int	value
	)

Columns count.

◆ eci_encoding() [1/2]

int eci_encoding ( 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.
Not applied for Macro PDF417 text fields.
Current implementation consists all well known charset encodings.

◆ eci_encoding() [2/2]

None eci_encoding	(		self,
		int	value
	)

Extended Channel Interpretation Identifiers.
It is used to tell the barcode reader details about the used references
for encoding the data in the symbol.
Not applied for Macro PDF417 text fields.
Current implementation consists all well known charset encodings.

◆ encode_mode() [1/2]

int encode_mode ( self )

Identifies Pdf417 encode mode.
Default value: Auto.

◆ encode_mode() [2/2]

None encode_mode	(		self,
		int	value
	)

Identifies Pdf417 encode mode.
Default value: Auto.

◆ error_level() [1/2]

Pdf417ErrorLevel error_level ( self )

Level of Reed-Solomon error correction for QR, MicroQR and RectMicroQR barcode.
From low to high: LevelL, LevelM, LevelQ, LevelH. See QRErrorLevel.

◆ error_level() [2/2]

None error_level	(		self,
		Pdf417ErrorLevel	value
	)

Level of Reed-Solomon error correction for QR, MicroQR and RectMicroQR barcode.
From low to high: LevelL, LevelM, LevelQ, LevelH. See QRErrorLevel.

◆ linked() [1/2]

bool linked ( 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

◆ linked() [2/2]

None linked	(		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

boolean value

◆ macro_characters() [1/2]

int macro_characters ( 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

◆ macro_characters() [2/2]

None macro_characters	(		self,
		MacroCharacter	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

MacroCharacters int value

◆ macro_pdf_417_addressee() [1/2]

Optional[str] macro_pdf_417_addressee ( self )

Gets macro Pdf417 barcode addressee name.

◆ macro_pdf_417_addressee() [2/2]

None macro_pdf_417_addressee	(		self,
		str	value
	)

Sets macro Pdf417 barcode addressee name.

◆ macro_pdf_417_checksum() [1/2]

int macro_pdf_417_checksum ( 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.

◆ macro_pdf_417_checksum() [2/2]

None macro_pdf_417_checksum	(		self,
		int	value
	)

Sets macro Pdf417 barcode checksum.

Parameters

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

◆ macro_pdf_417_eci_encoding() [1/4]

int macro_pdf_417_eci_encoding ( self )

Extended Channel Interpretation Identifiers.
Applies for Macro PDF417 text fields.

◆ macro_pdf_417_eci_encoding() [2/4]

int macro_pdf_417_eci_encoding ( self )

Extended Channel Interpretation Identifiers.

Applies for Macro PDF417 text fields.

Returns: pdf417MacroECIEncoding int value

◆ macro_pdf_417_eci_encoding() [3/4]

None macro_pdf_417_eci_encoding	(		self,
		int	value
	)

Extended Channel Interpretation Identifiers.
Applies for Macro PDF417 text fields.

◆ macro_pdf_417_eci_encoding() [4/4]

None macro_pdf_417_eci_encoding	(		self,
		int	value
	)

Extended Channel Interpretation Identifiers.

Applies for Macro PDF417 text fields.

Parameters

value int value

◆ macro_pdf_417_file_id() [1/2]

int macro_pdf_417_file_id ( self )

Gets macro Pdf417 barcode's file ID.

Used for MacroPdf417.

◆ macro_pdf_417_file_id() [2/2]

None macro_pdf_417_file_id	(		self,
		int	value
	)

Sets macro Pdf417 barcode's file ID.

Used for MacroPdf417.

◆ macro_pdf_417_file_name() [1/2]

Optional[str] macro_pdf_417_file_name ( self )

Gets macro Pdf417 barcode file name.

◆ macro_pdf_417_file_name() [2/2]

None macro_pdf_417_file_name	(		self,
		str	value
	)

Sets macro Pdf417 barcode file name.

◆ macro_pdf_417_file_size() [1/2]

int macro_pdf_417_file_size ( self )

Gets macro Pdf417 file size.

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

◆ macro_pdf_417_file_size() [2/2]

None macro_pdf_417_file_size	(		self,
		int	value
	)

Sets macro Pdf417 file size.

Parameters

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

◆ macro_pdf_417_segment_id() [1/2]

int macro_pdf_417_segment_id ( self )

Gets macro Pdf417 barcode's segment ID.

◆ macro_pdf_417_segment_id() [2/2]

None macro_pdf_417_segment_id	(		self,
		int	value
	)

Sets macro Pdf417 barcode's segment ID.

◆ macro_pdf_417_segments_count() [1/2]

int macro_pdf_417_segments_count ( self )

Gets macro Pdf417 barcode segments count.

◆ macro_pdf_417_segments_count() [2/2]

None macro_pdf_417_segments_count	(		self,
		int	value
	)

Sets macro Pdf417 barcode segments count.

◆ macro_pdf_417_sender() [1/2]

Optional[str] macro_pdf_417_sender ( self )

Gets macro Pdf417 barcode sender name.

◆ macro_pdf_417_sender() [2/2]

None macro_pdf_417_sender	(		self,
		str	value
	)

Sets macro Pdf417 barcode sender name.

◆ macro_pdf_417_terminator() [1/2]

Pdf417MacroTerminator macro_pdf_417_terminator ( 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

◆ macro_pdf_417_terminator() [2/2]

None macro_pdf_417_terminator	(		self,
		Pdf417MacroTerminator	value
	)

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

Applied only for Macro PDF417.

Parameters

value int value

◆ macro_pdf_417_time_stamp() [1/2]

datetime macro_pdf_417_time_stamp ( self )

Gets macro Pdf417 barcode time stamp.

◆ macro_pdf_417_time_stamp() [2/2]

None macro_pdf_417_time_stamp	(		self,
		datetime	value
	)

Sets macro Pdf417 barcode time stamp.

◆ pdf_417_compaction_mode() [1/2]

Pdf417CompactionMode pdf_417_compaction_mode ( self )

Pdf417 symbology type of BarCode's compaction mode.

Default value: Pdf417CompactionMode.AUTO.

◆ pdf_417_compaction_mode() [2/2]

None pdf_417_compaction_mode	(		self,
		Pdf417CompactionMode	value
	)

Pdf417 symbology type of BarCode's compaction mode.

Default value: Pdf417CompactionMode.AUTO.

◆ pdf_417_eci_encoding() [1/2]

int pdf_417_eci_encoding ( 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

◆ pdf_417_eci_encoding() [2/2]

None pdf_417_eci_encoding	(		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

pdf417ECIEncoding int value

◆ pdf_417_encode_mode() [1/2]

Pdf417EncodeMode pdf_417_encode_mode ( self )

Gets Pdf417 encode mode.

Default value: Auto.

Returns: Pdf417EncodeMode

◆ pdf_417_encode_mode() [2/2]

None pdf_417_encode_mode	(		self,
		Pdf417EncodeMode	value
	)

Sets Pdf417 encode mode.

Default value: Auto.

Parameters

Pdf417EncodeMode

◆ pdf_417_error_level() [1/2]

Pdf417ErrorLevel pdf_417_error_level ( self )

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

◆ pdf_417_error_level() [2/2]

None pdf_417_error_level	(		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.

◆ pdf_417_macro_addressee() [1/2]

Optional[str] pdf_417_macro_addressee ( self )

Gets macro Pdf417 barcode addressee name.

◆ pdf_417_macro_addressee() [2/2]

None pdf_417_macro_addressee	(		self,
		str	value
	)

Sets macro Pdf417 barcode addressee name.

◆ pdf_417_macro_checksum() [1/2]

int pdf_417_macro_checksum ( 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.

◆ pdf_417_macro_checksum() [2/2]

None pdf_417_macro_checksum	(		self,
		int	value
	)

Sets macro Pdf417 barcode checksum.

Parameters

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

◆ pdf_417_macro_eci_encoding() [1/2]

int pdf_417_macro_eci_encoding ( self )

Extended Channel Interpretation Identifiers.

Applies for Macro PDF417 text fields.

Returns: pdf417MacroECIEncoding int value

◆ pdf_417_macro_eci_encoding() [2/2]

None pdf_417_macro_eci_encoding	(		self,
		int	pdf417MacroECIEncoding
	)

Extended Channel Interpretation Identifiers.

Applies for Macro PDF417 text fields.

Parameters

pdf417MacroECIEncoding int value

◆ pdf_417_macro_file_id() [1/2]

int pdf_417_macro_file_id ( self )

Gets macro Pdf417 barcode's file ID.

Used for MacroPdf417.

◆ pdf_417_macro_file_id() [2/2]

None pdf_417_macro_file_id	(		self,
		int	value
	)

Sets macro Pdf417 barcode's file ID.

Used for MacroPdf417.

◆ pdf_417_macro_file_name() [1/2]

Optional[str] pdf_417_macro_file_name ( self )

Gets macro Pdf417 barcode file name.

◆ pdf_417_macro_file_name() [2/2]

None pdf_417_macro_file_name	(		self,
		str	value
	)

Sets macro Pdf417 barcode file name.

◆ pdf_417_macro_file_size() [1/2]

int pdf_417_macro_file_size ( self )

Gets macro Pdf417 file size.

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

◆ pdf_417_macro_file_size() [2/2]

None pdf_417_macro_file_size	(		self,
		int	value
	)

Sets macro Pdf417 file size.

Parameters

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

◆ pdf_417_macro_segment_id() [1/2]

int pdf_417_macro_segment_id ( self )

Gets macro Pdf417 barcode's segment ID.

◆ pdf_417_macro_segment_id() [2/2]

None pdf_417_macro_segment_id	(		self,
		int	value
	)

Sets macro Pdf417 barcode's segment ID.

◆ pdf_417_macro_segments_count() [1/2]

int pdf_417_macro_segments_count ( self )

Gets macro Pdf417 barcode segments count.

◆ pdf_417_macro_segments_count() [2/2]

None pdf_417_macro_segments_count	(		self,
		int	value
	)

Sets macro Pdf417 barcode segments count.

◆ pdf_417_macro_sender() [1/2]

Optional[str] pdf_417_macro_sender ( self )

Gets macro Pdf417 barcode sender name.

◆ pdf_417_macro_sender() [2/2]

None pdf_417_macro_sender	(		self,
		str	value
	)

Sets macro Pdf417 barcode sender name.

◆ pdf_417_macro_terminator() [1/2]

int pdf_417_macro_terminator ( 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

◆ pdf_417_macro_terminator() [2/2]

None pdf_417_macro_terminator	(		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

Pdf417MacroTerminator int value

◆ pdf_417_macro_time_stamp() [1/2]

datetime pdf_417_macro_time_stamp ( self )

Gets macro Pdf417 barcode time stamp.

◆ pdf_417_macro_time_stamp() [2/2]

None pdf_417_macro_time_stamp	(		self,
		datetime	value
	)

Sets macro Pdf417 barcode time stamp.

◆ pdf_417_truncate() [1/2]

bool pdf_417_truncate ( self )

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

◆ pdf_417_truncate() [2/2]

None pdf_417_truncate	(		self,
		bool	value
	)

Whether Pdf417 symbology type of BarCode is truncated.

◆ reader_initialization() [1/2]

bool reader_initialization ( self )

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

Returns: readerInitialization boolean value

◆ reader_initialization() [2/2]

None reader_initialization	(		self,
		bool	readerInitialization
	)

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

Parameters

readerInitialization boolean value

◆ rows() [1/2]

int rows ( self )

Rows count.

◆ rows() [2/2]

None rows	(		self,
		int	value
	)

Rows count.

◆ structured_append_mode_barcode_id() [1/2]

int structured_append_mode_barcode_id ( self )

Identifies the ID of the DotCode structured append mode barcode.
ID starts from 1 and must be less or equal to barcodes count.
Default value is -1.

◆ structured_append_mode_barcode_id() [2/2]

None structured_append_mode_barcode_id	(		self,
		int	value
	)

Identifies the ID of the DotCode structured append mode barcode.
ID starts from 1 and must be less or equal to barcodes count.
Default value is -1.

◆ truncate() [1/2]

bool truncate ( self )

Whether Pdf417 symbology type of BarCode is truncated (to reduce space).
Also known as CompactPDF417.
Right row indicator and right stop pattern are removed in this mode.

◆ truncate() [2/2]

None truncate	(		self,
		bool	value
	)

Whether Pdf417 symbology type of BarCode is truncated (to reduce space).
Also known as CompactPDF417.
Right row indicator and right stop pattern are removed in this mode.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __str__()

◆ aspect_ratio() [1/2]

◆ aspect_ratio() [2/2]

◆ code_128_emulation() [1/2]

◆ code_128_emulation() [2/2]

◆ columns() [1/2]

◆ columns() [2/2]

◆ eci_encoding() [1/2]

◆ eci_encoding() [2/2]

◆ encode_mode() [1/2]

◆ encode_mode() [2/2]

◆ error_level() [1/2]

◆ error_level() [2/2]

◆ linked() [1/2]

◆ linked() [2/2]

◆ macro_characters() [1/2]

◆ macro_characters() [2/2]

◆ macro_pdf_417_addressee() [1/2]

◆ macro_pdf_417_addressee() [2/2]

◆ macro_pdf_417_checksum() [1/2]

◆ macro_pdf_417_checksum() [2/2]

◆ macro_pdf_417_eci_encoding() [1/4]

◆ macro_pdf_417_eci_encoding() [2/4]

◆ macro_pdf_417_eci_encoding() [3/4]

◆ macro_pdf_417_eci_encoding() [4/4]

◆ macro_pdf_417_file_id() [1/2]

◆ macro_pdf_417_file_id() [2/2]

◆ macro_pdf_417_file_name() [1/2]

◆ macro_pdf_417_file_name() [2/2]

◆ macro_pdf_417_file_size() [1/2]

◆ macro_pdf_417_file_size() [2/2]

◆ macro_pdf_417_segment_id() [1/2]

◆ macro_pdf_417_segment_id() [2/2]

◆ macro_pdf_417_segments_count() [1/2]

◆ macro_pdf_417_segments_count() [2/2]

◆ macro_pdf_417_sender() [1/2]

◆ macro_pdf_417_sender() [2/2]

◆ macro_pdf_417_terminator() [1/2]

◆ macro_pdf_417_terminator() [2/2]

◆ macro_pdf_417_time_stamp() [1/2]

◆ macro_pdf_417_time_stamp() [2/2]

◆ pdf_417_compaction_mode() [1/2]

◆ pdf_417_compaction_mode() [2/2]

◆ pdf_417_eci_encoding() [1/2]

◆ pdf_417_eci_encoding() [2/2]

◆ pdf_417_encode_mode() [1/2]

◆ pdf_417_encode_mode() [2/2]

◆ pdf_417_error_level() [1/2]

◆ pdf_417_error_level() [2/2]

◆ pdf_417_macro_addressee() [1/2]

◆ pdf_417_macro_addressee() [2/2]

◆ pdf_417_macro_checksum() [1/2]

◆ pdf_417_macro_checksum() [2/2]

◆ pdf_417_macro_eci_encoding() [1/2]

◆ pdf_417_macro_eci_encoding() [2/2]

◆ pdf_417_macro_file_id() [1/2]

◆ pdf_417_macro_file_id() [2/2]

◆ pdf_417_macro_file_name() [1/2]

◆ pdf_417_macro_file_name() [2/2]

◆ pdf_417_macro_file_size() [1/2]

◆ pdf_417_macro_file_size() [2/2]

◆ pdf_417_macro_segment_id() [1/2]

◆ pdf_417_macro_segment_id() [2/2]

◆ pdf_417_macro_segments_count() [1/2]

◆ pdf_417_macro_segments_count() [2/2]

◆ pdf_417_macro_sender() [1/2]

◆ pdf_417_macro_sender() [2/2]

◆ pdf_417_macro_terminator() [1/2]

◆ pdf_417_macro_terminator() [2/2]

◆ pdf_417_macro_time_stamp() [1/2]

◆ pdf_417_macro_time_stamp() [2/2]

◆ pdf_417_truncate() [1/2]

◆ pdf_417_truncate() [2/2]

◆ reader_initialization() [1/2]

◆ reader_initialization() [2/2]

◆ init()

◆ str()