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 -> 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. |
Inherited Methods
The following methods are inherited from class CRegionObjectElement
.
Method | Description |
---|---|
GetLocation |
Gets the location of the CRegionObjectElement object. |
GetReferencedElement |
Gets a pointer to a referenced CRegionObjectElement object. |
GetElementType |
Gets the type of the CRegionObjectElement object. |
SetLocation |
Sets the location of the CRegionObjectElement object. |
Clone |
Clones the region object element. |
Retain |
Increases the reference count of the CRegionObjectElement object. |
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
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
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
SetFormat
Sets the format of the barcode.
virtual void SetFormat(BarcodeFormat format) = 0;
Parameters
[in] format
The format of the barcode.
See Also
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.