Result2D Class Reference

Class for storing the results of 2D barcode decoding. More...

#include <result.hpp>

Public Types
enum class	CompositeType { None = 0 , CCA = CExports::CVBCValueSymbology::CVBCVS_CCA , CCB = CExports::CVBCValueSymbology::CVBCVS_CCB , CCC = CExports::CVBCValueSymbology::CVBCVS_CCC }
	Enum class representing the type of composite barcode. More...

Public Member Functions
int	Rows () const noexcept
	Gets number of rows in the barcode. More...
int	Columns () const noexcept
	Gets number of columns in the barcode. More...
Size2D< float >	Size () const noexcept
	Gets size of the barcode in pixels. More...
int	Quality () const noexcept
	Gets barcode quality. More...
int	ErrorCorrectionCodewords ()
	Gets the number of used error correction codewords from a decoded 2D barcode. More...
int	ErrorCorrectionErasureCodewords ()
	Gets the number of used error correction erasure codewords from a decoded 2D barcode. More...
CompositeType	CompositeType ()
	Gets the type of the composite component. More...

Detailed Description

Class for storing the results of 2D barcode decoding.

This class holds the decoding results of a 2D barcode. A Result2D object is part of the Result class, which is obtained after executing the barcode decoding process with Decoder::Execute().

Note

A detailed description of the decoding and a code example can be found here.

Member Enumeration Documentation

CompositeType

enum class CompositeType

strong

Enum class representing the type of composite barcode.

For detailed information about composite barcodes, see configuration class Config::CompositeCodeBase.

Enumerator
None	Is not a composite component.
CCA	Composite Component A (CC-A).
CCB	Composite Component B (CC-B).
CCC	Composite Component C (CC-C).

Member Function Documentation

Columns()

int Columns ( ) const

inlinenoexcept

Gets number of columns in the barcode.

Returns

The number of columns.

CompositeType()

CompositeType CompositeType ( )

inline

Gets the type of the composite component.

Returns

The type of the composite component.

ErrorCorrectionCodewords()

int ErrorCorrectionCodewords ( )

inline

Gets the number of used error correction codewords from a decoded 2D barcode.

Returns

Number of used error correction codewords.

ErrorCorrectionErasureCodewords()

int ErrorCorrectionErasureCodewords ( )

inline

Gets the number of used error correction erasure codewords from a decoded 2D barcode.

Returns

Number of used error correction erasure codewords.

Quality()

int Quality ( ) const

inlinenoexcept

Gets barcode quality.

This value represents the quality of a 2D barcode, measured as an integer between 0 and 100.
It is calculated based on the Unused Error Correction, according to the specifications for the respective 2D symbology.

Returns

Barcode quality

Rows()

int Rows ( ) const

inlinenoexcept

Gets number of rows in the barcode.

Returns

The number of rows.

Size()

Size2D< float > Size ( ) const

inlinenoexcept

Gets size of the barcode in pixels.

Returns

Size of barcode.