Result2D Class Reference

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

#include <result.hpp>

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

Detailed Description

Class for storing the results of 2D code decoding.

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

Note

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

Member Function Documentation

Columns()

int Columns ( ) const

inlinenoexcept

Gets number of columns in the code.

Returns

The number of columns.

CompositeType()

CodeReader::CompositeType CompositeType ( ) const

inlinenoexcept

Gets the type of the composite component.

Returns

The type of the composite component.

ErrorCorrectionCodewords()

int ErrorCorrectionCodewords ( ) const

inlinenoexcept

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

Returns

Number of used error correction codewords.

ErrorCorrectionErasureCodewords()

int ErrorCorrectionErasureCodewords ( ) const

inlinenoexcept

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

Returns

Number of used error correction erasure codewords.

Quality()

int Quality ( ) const

inlinenoexcept

Gets code quality.

This value represents the quality of a 2D code, 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

Code quality

Rows()

int Rows ( ) const

inlinenoexcept

Gets number of rows in the code.

Returns

The number of rows.

Size()

Size2D< double > Size ( ) const

inlinenoexcept

Gets size of the code in pixels.

Returns

Size of code.