ReadResult Class Reference

Base class for reading decoded barcode results. More...

#include <cvb/barcode/read_result.hpp>

Inherited by ReadResult1D, and ReadResult2D.

Public Member Functions
	ReadResult (CExports::CVC_BC_INFO &handle)
	Constructor to initialize object from info struct. More...
virtual Cvb::String	Text () const noexcept
	The text content of the barcode. More...
int	CharactersRead () const
	The return value contains the number of characters in the read barcode. More...
int	DecodeTime () const
	The return value specifies the time consumed for decoding in units of ms. More...
std::vector< Cvb::Point2D< double > >	Location () const
	Location of the barcode inside the image. More...
int	NumWords () const
	Contains the number of code words composing the read barcode. More...
double	Resolution () const
	The resolution specifies the smallest width unit in the code in multiples of a 10th of a pixel. More...
DecodeResult	Result () const
	Decoding result. More...
Symbology	Type () const
	Symbology of the decoded result. More...

Detailed Description

Base class for reading decoded barcode results.

Use this result object in case of the following symbologies: Code32, FourStateAustralian, FourStateKix, FourStateRoyalMail, FourStateUsps, MicroPdf417, PharmaCode, Planet, Postnet

Constructor & Destructor Documentation

ReadResult()

ReadResult ( CExports::CVC_BC_INFO &  handle )

inline

Constructor to initialize object from info struct.

Exceptions

Any	exception derived from std::exception including CvbException.

Member Function Documentation

CharactersRead()

int CharactersRead ( ) const

inline

The return value contains the number of characters in the read barcode.

Returns

The return value contains the number of characters in the read barcode.

Exceptions

Any	exception derived from std::exception including CvbException.

DecodeTime()

int DecodeTime ( ) const

inline

The return value specifies the time consumed for decoding in units of ms.

Returns

The return value specifies the time consumed for decoding in units of ms.

Exceptions

Any	exception derived from std::exception including CvbException.

Location()

std::vector< Cvb::Point2D< double > > Location ( ) const

inline

Location of the barcode inside the image.

Returns

Location of the barcode inside the image.

Exceptions

Any	exception derived from std::exception including CvbException.

NumWords()

int NumWords ( ) const

inline

Contains the number of code words composing the read barcode.

Returns

Contains the number of code words composing the read barcode.

Exceptions

Any	exception derived from std::exception including CvbException.

Resolution()

double Resolution ( ) const

inline

The resolution specifies the smallest width unit in the code in multiples of a 10th of a pixel.

Returns

The resolution specifies the smallest width unit in the code in multiples of a 10th of a pixel.

Exceptions

Any	exception derived from std::exception including CvbException.

Result()

DecodeResult Result ( ) const

inline

Decoding result.

Returns

Result of a read operation (note that read operations may partly succeed, which is not considered an error).

Exceptions

Any	exception derived from std::exception including CvbException.

Text()

virtual Cvb::String Text ( ) const

inlinevirtualnoexcept

The text content of the barcode.

Returns

The text content of the barcode.

Exceptions

Any	exception derived from std::exception including CvbException.

Type()

Symbology Type ( ) const

inline

Symbology of the decoded result.

Returns

The type element contains one of the Barcode::Symbology. This can also be Symbology::None if no barcode has been recognised.

Exceptions

Any	exception derived from std::exception including CvbException.