Result Class Reference

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

#include <result.hpp>

Public Member Functions
String	Data () const
	Gets the decoded barcode data. More...
Point2D< int >	Center () const noexcept
	Gets center coordinates of decoded barcode. More...
std::array< Point2D< int >, 4 >	Corners () const noexcept
	Gets corner coordinates of decoded barcode. More...
Symbology	SymbologyType () const noexcept
	Gets symbology type of decoded barcode. More...
DecodeStatus	DecodeStatus () const noexcept
	Gets decoding status of decoded barcode. More...
Cvb::optional< class Result2D >	Result2D () const noexcept
	Gets the result of a 2D barcode, if available. More...

Detailed Description

Class for storing the results of barcode decoding.

This class holds the results of a decoded barcode. After executing the barcode decoding process with Decoder::Execute(), a vector of Result objects is returned, containing the decoding outcomes.

Note

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

Member Function Documentation

Center()

Point2D< int > Center ( ) const

inlinenoexcept

Gets center coordinates of decoded barcode.

Returns

Center coordinates of decoded barcode.

Corners()

std::array< Point2D< int >, 4 > Corners ( ) const

inlinenoexcept

Gets corner coordinates of decoded barcode.

Returns

Corner coordinates of decoded barcode.

Data()

String Data ( ) const

inline

Gets the decoded barcode data.

Returns

The decoded barcode data.

DecodeStatus()

DecodeStatus DecodeStatus ( ) const

inlinenoexcept

Gets decoding status of decoded barcode.

Returns

Decoding status of decoded barcode.

Result2D()

Cvb::optional< class Result2D > Result2D ( ) const

inlinenoexcept

Gets the result of a 2D barcode, if available.

This function returns a 2D barcode result if the decoded barcode is of a 2D type. If the decoded barcode is not a 2D barcode, an empty result is returned.

Returns

The result of a 2D barcode, if available.

SymbologyType()

Symbology SymbologyType ( ) const

inlinenoexcept

Gets symbology type of decoded barcode.

Returns

Symbology type of decoded barcode.