CandidateBarcodeZonesUnit Class

CandidateBarcodeZonesUnit extends the IntermediateResultUnit class and represents a unit which contains a candidate barcode zone.

Definition

Assembly: DynamsoftBarcodeReader.aar

Namespace: com.dynamsoft.dbr.intermediate_results

class CandidateBarcodeZonesUnit extends IntermediateResultUnit

Method	Description
`getCandidateBarcodeZones`	Returns the candidate barcode zones.
`getCount`	Returns the number of candidate barcode zones.
`getCandidateBarcodeZone`	Returns a candidate barcode zone.
`removeAllCandidateBarcodeZones`	Removes all candidate barcode zones.
`removeCandidateBarcodeZone`	Removes a candidate barcode zone.
`addCandidateBarcodeZone`	Adds a candidate barcode zone.
`setCandidateBarcodeZone`	Sets a candidate barcode zone.

The following methods are inherited from class IntermediateResultUnit.

Method	Description
`getHashId`	Gets the hash ID of the unit.
`getOriginalImageHashId`	Gets the hash ID of the original image.
`getOriginalImageTag`	Gets the image tag of the original image.
`getType`	Gets the type of the intermediate result unit.
`getTransformMatrix`	Gets the transformation matrix via `DSTransformMatrixType`.
`clone`	Creates a copy of the intermediate result unit.
`replace`	Replaces the content of the intermediate result unit.

Returns the candidate barcode zones as an array of CandidateBarcodeZone items.

CandidateBarcodeZone[] getCandidateBarcodeZones()

Return Value

An array of CandidateBarcodeZone items.

Returns the number of candidate barcode zones.

int getCount()

Return Value

The number of candidate barcode zones.

Returns the CandidateBarcodeZone from the full array of candidate barcode zone(s) as specified by the index.

CandidateBarcodeZone getCandidateBarcodeZone(int index)

Parameters

[in] index: The index of the candidate barcode zone.

Return Value

A CandidateBarcodeZone object.

Removes all of the candidate barcode zones.

void removeAllCandidateBarcodeZones()

Removes the CandidateBarcodeZone at the specified index.

int removeCandidateBarcodeZone(int index)

Parameters

[in] index: The index of the candidate barcode zone.

Return Value

Returns the ErrorCode if it fails. Otherwise, returns 0.

Adds a CandidateBarcodeZone to the candidate barcode zones array.

int addCandidateBarcodeZone(CandidateBarcodeZone barcodeZone, Matrix matrixToOriginalImage)

Parameters

[in] barcodeZone: The CandidateBarcodeZone to be added.

[in] matrixToOriginalImage: The transformation Matrix of the original image.

Return Value

Returns the ErrorCode if it fails. Otherwise, returns 0.

Sets the CandidateBarcodeZone at the specified index.

int setCandidateBarcodeZone(int index, CandidateBarcodeZone barcodeZone, Matrix matrixToOriginalImage)

Parameters

[in] index: The index where the new candidate barcode zone will be added.

[in] barcodeZone: The CandidateBarcodeZone to be set.

[in] matrixToOriginalImage: The transformation Matrix of the original image.

Return Value

Returns the ErrorCode if it fails. Otherwise, returns 0.