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

Public Types
enum	CompositeType { None = 0 , CCA = SymbologyConverter.CVCRValueSymbology.CVCRVS_CCA , CCB = SymbologyConverter.CVCRValueSymbology.CVCRVS_CCB , CCC = SymbologyConverter.CVCRValueSymbology.CVCRVS_CCC }
	Enum class representing the type of composite code. More...

Public Member Functions
	Result2D (int errorCorrectionCodewords, int errorCorrectionErasureCodewords, int quality, int rows, int columns, Size2Dd size, CompositeType compositeType)
	Constructor.

Properties
int	ErrorCorrectionCodewords `[get]`
	Number of used error correction codewords from a decoded 2D code.

int	ErrorCorrectionErasureCodewords `[get]`
	Number of used error correction erasure codewords from a decoded 2D code.

int	Quality `[get]`
	Quality measure for 2D codes.

int	Rows `[get]`
	Number of rows.

int	Columns `[get]`
	Number of columns.

Size2Dd	Size `[get]`
	Size of code.

CompositeType	Composite `[get]`
	Composite type.

Detailed Description

Class for storing the results of decoding 2D codes.

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(ImagePlane, int).

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

Member Enumeration Documentation

◆ CompositeType

enum CompositeType

Enum class representing the type of composite code.

For detailed information about composite codes, see configuration class Config.CompositeCodeBase<T>

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).

Constructor & Destructor Documentation

◆ Result2D()

Result2D	(	int	errorCorrectionCodewords,
		int	errorCorrectionErasureCodewords,
		int	quality,
		int	rows,
		int	columns,
		Size2Dd	size,
		CompositeType	compositeType )

Constructor.

Parameters

errorCorrectionCodewords	Number of used error correction codewords from a decoded 2D code.
errorCorrectionErasureCodewords	Number of used error correction erasure codewords from a decoded 2D code.
quality	Quality measure.
rows	Number of rows.
columns	Number of columns.
size	Size.
compositeType	Composite type.

Property Documentation

◆ Quality

int Quality

get

Quality measure for 2D codes.

This is an integer value between 0 – 100 computed as the Unused Error Correction per 2D symbology specifications.

Public Types

Public Member Functions