Aspose.Barcode for PHP via Java Generation and Recognition API docs
Pdf417ExtendedParameters Class Reference

Inherits BaseJavaClass.

Public Member Functions

 getMacroPdf417FileID ()
 
 getMacroPdf417SegmentID ()
 
 getMacroPdf417SegmentsCount ()
 
 getMacroPdf417FileName ()
 
 getMacroPdf417FileSize ()
 
 getMacroPdf417Sender ()
 
 getMacroPdf417Addressee ()
 
 getMacroPdf417TimeStamp ()
 
 getMacroPdf417Checksum ()
 
 getMacroPdf417Terminator ()
 
 isReaderInitialization ()
 
 isLinked ()
 
 isCode128Emulation ()
 
 equals (Pdf417ExtendedParameters $obj)
 
 hashCode ()
 
 toString ()
 
- Public Member Functions inherited from BaseJavaClass
 __construct ($javaClass)
 
 getJavaClass ()
 
 getJavaClassName ()
 
 isNull ()
 
 printJavaClassName ()
 

Protected Member Functions

 init ()
 
- Protected Member Functions inherited from BaseJavaClass
 setJavaClass ($javaClass)
 

Detailed Description

Stores a MacroPdf417 metadata information of recognized barcode

This sample shows how to get Macro Pdf417 metadata

$generator = new 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");
$reader = new BarCodeReader("test.png", DecodeType::MACRO_PDF_417);
foreach($reader->readBarCodes() as $result)
{
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());
}

Member Function Documentation

◆ equals()

Pdf417ExtendedParameters::equals ( Pdf417ExtendedParameters  $obj)

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

Parameters
Pdf417ExtendedParameters$objAn System.Object value to compare to this instance.
Returns
bool true if obj has the same value as this instance; otherwise, false.

◆ getMacroPdf417Addressee()

Pdf417ExtendedParameters::getMacroPdf417Addressee ( )

Macro PDF417 addressee name (optional).

Returns
string Addressee name.

◆ getMacroPdf417Checksum()

Pdf417ExtendedParameters::getMacroPdf417Checksum ( )

Macro PDF417 checksum (optional).

Returns
int Checksum.

◆ getMacroPdf417FileID()

Pdf417ExtendedParameters::getMacroPdf417FileID ( )

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

◆ getMacroPdf417FileName()

Pdf417ExtendedParameters::getMacroPdf417FileName ( )

Macro PDF417 file name (optional).

Returns
string File name.

◆ getMacroPdf417FileSize()

Pdf417ExtendedParameters::getMacroPdf417FileSize ( )

Macro PDF417 file size (optional).

Returns
int File size.

◆ getMacroPdf417SegmentID()

Pdf417ExtendedParameters::getMacroPdf417SegmentID ( )

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

◆ getMacroPdf417SegmentsCount()

Pdf417ExtendedParameters::getMacroPdf417SegmentsCount ( )

Gets macro pdf417 barcode segments count. Default value is -1.Value: Segments count.

◆ getMacroPdf417Sender()

Pdf417ExtendedParameters::getMacroPdf417Sender ( )

Macro PDF417 sender name (optional).

Returns
string Sender name

◆ getMacroPdf417Terminator()

Pdf417ExtendedParameters::getMacroPdf417Terminator ( )

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

Returns
Terminator.

◆ getMacroPdf417TimeStamp()

Pdf417ExtendedParameters::getMacroPdf417TimeStamp ( )

Macro PDF417 time stamp (optional).

Returns
DateTime Time stamp.

◆ hashCode()

Pdf417ExtendedParameters::hashCode ( )

Returns the hash code for this instance.

Returns
int A 32-bit signed integer hash code.

◆ init()

Pdf417ExtendedParameters::init ( )
protected

Reimplemented from BaseJavaClass.

◆ isCode128Emulation()

Pdf417ExtendedParameters::isCode128Emulation ( )

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

Returns
Code 128 emulation flag

◆ isLinked()

Pdf417ExtendedParameters::isLinked ( )

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

Value: Linkage flag

◆ isReaderInitialization()

Pdf417ExtendedParameters::isReaderInitialization ( )

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

Value: Reader initialization flag

◆ toString()

Pdf417ExtendedParameters::toString ( )

Returns a human-readable string representation of this Pdf417ExtendedParameters.

Returns
int A string that represents this Pdf417ExtendedParameters.