Result Class Reference

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

#include <result.hpp>

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

Detailed Description

Class for storing the results of decoding.

This class holds the results of a read code. After executing the 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 read code.

Returns

Center coordinates of read code.

Corners()

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

inlinenoexcept

Gets corner coordinates of read code.

The corners define the bounding box of the decoded code, listed in clockwise order starting from corner 0. Corner 0 corresponds to the upper-left corner of the code in its standard, un-rotated orientation.

Returns

Corner coordinates of read code.

Data()

String Data ( ) const

inline

Gets the decoded decoded data.

Returns

The decoded decoded data.

DecodeStatus()

CodeReader::DecodeStatus DecodeStatus ( ) const

inlinenoexcept

Gets decoding status of read code.

Returns

Decoding status of read code.

Result2D()

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

inlinenoexcept

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

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

Returns

The result of a 2D code, if available.

SymbologyType()

Symbology SymbologyType ( ) const

inlinenoexcept

Gets symbology type of read code.

Returns

Symbology type of read code.