DSCandidateBarcodeZonesUnit Class

DSCandidateBarcodeZonesUnit extends the DSIntermediateResultUnit class and represents a unit which contains a candidate barcode zone.

Definition

Assembly: DynamsoftBarcodeReader.xcframework

Objective-C
Swift

@interface DSCandidateBarcodeZonesUnit : DSIntermediateResultUnit

class CandidateBarcodeZonesUnit : IntermediateResultUnit

Methods

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 DSIntermediateResultUnit.

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.

getCandidateBarcodeZones

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

Objective-C
Swift

-(nullable NSArray< DSCandidateBarcodeZone* >*)getCandidateBarcodeZones;

func getCandidateBarcodeZones() -> [CandidateBarcodeZone]?

Return Value

An array of DSCandidateBarcodeZone items.

getCount

Returns the number of candidate barcode zones.

Objective-C
Swift

```
-(NSInteger)getCount;
```
```
func getCount() -> Int
```

Return Value

The number of candidate barcode zones.

getCandidateBarcodeZone

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

Objective-C
Swift

-(DSCandidateBarcodeZone *)getCandidateBarcodeZone:(NSInteger)index;

func getCandidateBarcodeZone(index: Int) -> CandidateBarcodeZone?

Parameters

index: The index of the candidate barcode zone.

Return Value

A DSCandidateBarcodeZone object.

removeAllCandidateBarcodeZones

Removes all of the candidate barcode zones.

Objective-C
Swift

```
-(void)removeAllCandidateBarcodeZones;
```
```
func removeAllCandidateBarcodeZones()
```

removeCandidateBarcodeZone

Removes the DSCandidateBarcodeZone at the specified index.

Objective-C
Swift

-(NSInteger)removeCandidateBarcodeZone:(NSInteger)index;

func removeCandidateBarcodeZone(index: Int) -> Int

Parameters

index: The index of the candidate barcode zone.

Return Value

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

addCandidateBarcodeZone

Adds a CandidateBarcodeZone to the candidate barcode zones array.

Objective-C
Swift

-(NSInteger)addCandidateBarcodeZone:(DSCandidateBarcodeZone*)barcodeZone
matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;

func addCandidateBarcodeZone(barcodeZone: CandidateBarcodeZone, matrixToOriginalImage: CGAffineTransform) -> Int

Parameters

barcodeZone: The candidate barcode zone to be added.

matrixToOriginalImage: The CGAffineTransform transformation matrix of the original image.

Return Value

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

setCandidateBarcodeZone

Sets the CandidateBarcodeZone at the specified index.

Objective-C
Swift

-(NSInteger)setCandidateBarcodeZone:(NSInteger)index
                    barcodeZone:(DSCandidateBarcodeZone*)barcodeZone
          matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;

func setCandidateBarcodeZone(index: Int, barcodeZone: CandidateBarcodeZone, matrixToOriginalImage: CGAffineTransform) -> Int

Parameters

index: The index of the candidate barcode zone.

barcodeZone: The candidate barcode zone to be set.

matrixToOriginalImage: The CGAffineTransfrom transformation matrix of the original image.

Return Value

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