Skip to content

localized-barcodes-unit.md

Latest commit

 

History

History
162 lines (102 loc) · 6.33 KB

localized-barcodes-unit.md

File metadata and controls

162 lines (102 loc) · 6.33 KB
layout default-layout
title CLocalizedBarcodesUnit Class - Dynamsoft Barcode Reader C++ Edition API Reference
description API reference for the CLocalizedBarcodesUnit class in Dynamsoft Barcode Reader C++ Edition, an intermediate result unit that holds all localized (but not yet decoded) barcode elements found in an image.
keywords GetCount, GetLocalizedBarcode, AddLocalizedBarcode, RemoveAllLocalizedBarcodes, RemoveLocalizedBarcode, SetLocalizedBarcode, CLocalizedBarcodesUnit, api reference

CLocalizedBarcodesUnit Class

The CLocalizedBarcodesUnit class represents a unit that contains localized barcodes unit. It inherits from the CIntermediateResultUnit class.

Definition

Namespace: dynamsoft::dbr::intermediate_results

Assembly: DynamsoftBarcodeReader

Inheritance: [CIntermediateResultUnit]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html) -> CLocalizedBarcodesUnit

class CLocalizedBarcodesUnit: public CIntermediateResultUnit

Methods

Method Description
AddLocalizedBarcode Adds a localized barcode.
GetLocalizedBarcode Gets a pointer to a specific localized barcode element.
GetCount Gets the number of localized barcodes in the unit.
RemoveAllLocalizedBarcodes Removes all the localized barcodes.
RemoveLocalizedBarcode Removes a localized barcode at the specified index.
SetLocalizedBarcode Sets a localized barcode at the specified index.
operator[] Gets a pointer to a specific localized barcode element.
Methods Inherited from [CIntermediateResultUnit]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html):
[GetHashId]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gethashid) Gets the hash ID of the unit.
[GetOriginalImageHashId]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagehashid) Gets the hash ID of the original image.
[GetOriginalImageTag]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagetag) Gets the image tag of the original image.
[GetType]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gettype) Gets the type of the intermediate result unit.
[Clone]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#clone) Creates a copy of the intermediate result unit.
[SetHashId]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#sethashid) Sets the hash ID of the unit.
[SetOriginalImageHashId]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#setoriginalimagehashid) Sets the hash ID of the original image.
[SetOriginalImageTag]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#setoriginalimagetag) Sets the image tag of the original image.
[Retain]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#retain) Increases the reference count of the unit.
[Release]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#release) Decreases the reference count of the unit.
[GetTransformMatrix]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gettransformmatrix) Gets the transformation matrix via TransformMatrixType.
[SetTransformMatrix]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#settransformmatrix) Sets the transformation matrix via TransformMatrixType.

AddLocalizedBarcode

Adds a localized barcode.

virtual int AddLocalizedBarcode(const CLocalizedBarcodeElement* element, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0;

Parameters

element The localized barcode element to be added.

matrixToOriginalImage The matrix to original image.

Return value

Returns 0 if successful, otherwise returns a negative value.

GetCount

Gets the number of localized barcodes in the unit.

virtual int GetCount() const = 0;

Return value

Returns the number of localized barcodes in the unit.

GetLocalizedBarcode

Gets a pointer to a specific localized barcode element.

virtual const CLocalizedBarcodeElement* GetLocalizedBarcode(int index) const = 0;

Parameters

[in] index The index of the localized barcode element to retrieve.

Return value

Returns a const pointer to the localized barcode element at the specified index.

See Also

[CLocalizedBarcodeElement]({{ site.dbr_cpp_api }}localized-barcode-element.html)

RemoveAllLocalizedBarcodes

Removes all the localized barcodes

virtual void RemoveAllLocalizedBarcodes() = 0;

RemoveLocalizedBarcode

Removes a localized barcode at the specified index

virtual int RemoveLocalizedBarcode(int index) = 0;

Parameters

index The index of the localized barcode.

Return value

Returns 0 if successful, otherwise returns a negative value.

SetLocalizedBarcode

Sets a localized barcode at the specified index.

virtual int SetLocalizedBarcode(int index, const CLocalizedBarcodeElement* element, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0;

Parameters

index The index of the localized barcode.

element The localized barcode element to be set.

matrixToOriginalImage The matrix to original image.

Return value

Returns 0 if successful, otherwise returns a negative value.

operator[]

Gets a pointer to a specific localized barcode element.

virtual const CLocalizedBarcodeElement* operator[](int index) const = 0;

Parameters

[in] index The index of the localized barcode element to retrieve.

Return value

Returns a const pointer to the localized barcode element at the specified index.

See Also

[CLocalizedBarcodeElement]({{ site.dbr_cpp_api }}localized-barcode-element.html)