Skip to content

decoded-barcode-element.md

Latest commit

 

History

History
324 lines (202 loc) · 9.29 KB

decoded-barcode-element.md

File metadata and controls

324 lines (202 loc) · 9.29 KB
layout default-layout
title CDecodedBarcodeElement Class - Dynamsoft Barcode Reader C++ Edition API Reference
description API reference for the CDecodedBarcodeElement class in Dynamsoft Barcode Reader C++ Edition, an intermediate result element providing format, text, raw bytes, angle, confidence, DPM flag, and ECI segment data for a decoded barcode.
keywords GetFormat, GetText, GetBytes, GetAngle, GetConfidence, IsDPM, CDecodedBarcodeElement, api reference

CDecodedBarcodeElement Class

The CDecodedBarcodeElement class represents a decoded barcode element. It inherits from the CRegionObjectElement class and provides additional functionality for retrieving information about the decoded barcode.

Definition

Namespace: dynamsoft::dbr

Assembly: DynamsoftBarcodeReader

Inheritance: [CRegionObjectElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html) -> CDecodedBarcodeElement

class CDecodedBarcodeElement : public CRegionObjectElement

Methods

Method Description
GetFormat Gets the format of the barcode.
GetFormatString Gets the string representation of the barcode format.
GetText Gets the text of the decoded barcode.
GetBytes Gets the raw bytes of the decoded barcode.
GetBytesLength Gets the length of the raw bytes of the decoded barcode.
GetDetails Gets the details of the decoded barcode.
IsDPM Determines whether the decoded barcode is a DPM (Direct Part Marking) code.
IsMirrored Determines whether the decoded barcode is mirrored.
GetAngle Gets the orientation angle of the barcode.
GetModuleSize Gets the module size of the barcode.
GetConfidence Gets the confidence score of the barcode recognition result.
GetExtendedBarcodeResultsCount Gets the number of extended barcode results for the decoded barcode.
GetExtendedBarcodeResult Gets the extended barcode result at the specified index for the decoded barcode.
SetFormat Sets the format of the barcode.
SetText Sets the text of the decoded barcode.
SetBytes Sets the raw bytes of the decoded barcode.
SetConfidence Sets the confidence score of the barcode recognition result.
GetECISegmentsCount Gets the number of ECI segments in the barcode.
GetECISegment Gets the ECI segment at the specified index.
Methods Inherited from [CRegionObjectElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html):
[GetLocation]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getlocation) Gets the location of the region object element.
[GetReferencedElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getreferencedelement) Gets a pointer to a referenced region object element.
[GetElementType]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getelementtype) Gets the type of the region object element.
[GetImageData]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getimagedata) Gets the imageData of the region object element.
[Clone]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#clone) Clone the region object element.
[Retain]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#retain) Increases the reference count of the CRegionObjectElement object.
[Release]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#release) Decreases the reference count of the CRegionObjectElement object.

GetFormat

It is used to get the format of the barcode.

BarcodeFormat GetFormat()

Return value

Returns the format of the barcode.

See Also

[Enumeration BarcodeFormat]({{ site.dbr_cpp_api }}enum-barcode-format.html?src=cpp&&lang=cpp)

GetFormatString

It is used to get the string representation of the barcode format.

const char* GetFormatString() const

Return value

Returns the string representation of the barcode format.

GetText

Gets the text of the decoded barcode.

virtual const char* GetText() const = 0;

Return value

Returns a pointer to the text of the decoded barcode.

GetBytes

Gets the raw bytes of the decoded barcode.

virtual unsigned char* GetBytes() const = 0;

Return value

Returns a pointer to the raw bytes of the decoded barcode.

GetBytesLength

Gets the length of the raw bytes of the decoded barcode.

virtual int GetBytesLength() const = 0;

Return value

Returns the length of the raw bytes of the decoded barcode.

GetDetails

Gets the details of the decoded barcode.

virtual const CBarcodeDetails* GetDetails() const = 0;

Return value

Returns a pointer to the details of the decoded barcode.

See Also

  • [CAztecDetails]({{ site.dbr_cpp_api }}aztec-details.html)
  • [CBarcodeDetails]({{ site.dbr_cpp_api }}barcode-details.html)
  • [CDataMatrixDetails]({{ site.dbr_cpp_api }}datamatrix-details.html)
  • [COneDCodeDetails]({{ site.dbr_cpp_api }}oned-code-details.html)
  • [CPDF417Details]({{ site.dbr_cpp_api }}pdf417-details.html)
  • [CQRCodeDetails]({{ site.dbr_cpp_api }}qr-code-details.html)

IsDPM

Determines whether the decoded barcode is a DPM (Direct Part Marking) code.

virtual bool IsDPM() const = 0;

Return value

Returns true if the decoded barcode is a DPM code, false otherwise.

IsMirrored

Determines whether the decoded barcode is mirrored.

virtual bool IsMirrored() const = 0;

Return value

Returns true if the decoded barcode is mirrored, false otherwise.

GetAngle

It is used to get the orientation angle of the barcode.

int GetAngle() const

Return value

Returns the orientation angle of the barcode.

GetModuleSize

It is used to get the module size of the barcode.

int GetModuleSize() const

Return value

Returns the module size of the barcode.

GetConfidence

It is used to get the confidence score of the barcode recognition result.

int GetConfidence() const

Return value

Returns the confidence score of the barcode recognition result.

GetExtendedBarcodeResultsCount

Gets the number of extended barcode results for the decoded barcode.

virtual int GetExtendedBarcodeResultsCount() const = 0;

Return value

Returns the number of extended barcode results for the decoded barcode.

GetExtendedBarcodeResult

Gets the extended barcode result at the specified index for the decoded barcode.

virtual const CExtendedBarcodeResult* GetExtendedBarcodeResult(int index) const = 0;

Parameters

[in] index The index of the extended barcode result to retrieve.

Return value

Returns a pointer to the extended barcode result at the specified index for the decoded barcode.

See Also

[CExtendedBarcodeResult]({{ site.dbr_cpp_api }}extended-barcode-result.html)

SetFormat

Sets the format of the barcode.

virtual void SetFormat(BarcodeFormat format) = 0;

Parameters

[in] format The format of the barcode.

See Also

[Enumeration BarcodeFormat]({{ site.dbr_cpp_api }}enum-barcode-format.html?src=cpp&&lang=cpp)

SetText

Sets the text of the barcode.

virtual void SetText(const char* text) = 0;

Parameters

[in] text The text of the barcode.

SetBytes

Sets the raw bytes of the barcode.

virtual void SetBytes(unsigned char* bytes, int bytesLength) = 0;

Parameters

[in] bytes The raw bytes of the barcode.

[in] bytesLength The length of the raw bytes of the decoded barcode.

SetConfidence

Sets the confidence of the barcode.

virtual void SetConfidence(int confidence) = 0;

Parameters

[in] confidence The confidence of the barcode.

GetECISegmentsCount

Gets the number of ECI segments in the barcode.

virtual int GetECISegmentsCount() const = 0;

Return value

Returns the count of ECI segments. Returns 0 if no ECI information is present.

Remarks

Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000.

GetECISegment

Gets the ECI segment at the specified index.

virtual const CECISegment* GetECISegment(int index) const = 0;

Parameters

[in] index The zero-based index of the ECI segment to retrieve.

Return value

Returns a pointer to the [CECISegment]({{ site.dbr_cpp_api }}eci-segment.html) object, or NULL if the index is out of range.

See Also

[CECISegment]({{ site.dbr_cpp_api }}eci-segment.html)

Remarks

Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000.