CVB++ 15.0
Qr Class Reference

Configuration to access parameters of Qr. More...

#include <cvb/barcode/_detail/qr.hpp>

Inherits Reader2DWithQuietzoneConfigBase.

Public Member Functions

void SetMaxVersionMiniQr (int maxVersionMiniQR)
 Limiting values for Mini-QR-code ranging from 1 to 4. The default value is 1 (min) to 4 (max) to decode all Mini-QR-Code-versions. More...
 
int MaxVersionMiniQr () const
 Limiting values for Mini-QR-code ranging from 1 to 4. The default value is 1 (min) to 4 (max) to decode all Mini-QR-Code-versions. More...
 
void SetMaxVersionStandardQr (int maxVersionStandardQR)
 Limiting values for standard-QR-code ranging from 1 to 40. The default value is 1 (min) to 40 (max) to decode all standard-QR-Code-versions. More...
 
int MaxVersionStandardQr () const
 Limiting values for standard-QR-code ranging from 1 to 40. The default value is 1 (min) to 40 (max) to decode all standard-QR-Code-versions. More...
 
void SetMinVersionMiniQr (int minVersionMiniQR)
 Limiting values for Mini-QR-code ranging from 1 to 4. The default value is 1 (min) to 4 (max) to decode all Mini-QR-Code-versions. More...
 
int MinVersionMiniQr () const
 Limiting values for Mini-QR-code ranging from 1 to 4. The default value is 1 (min) to 4 (max) to decode all Mini-QR-Code-versions. More...
 
void SetMinVersionStandardQr (int minVersionStandardQR)
 Limiting values for standard-QR-code ranging from 1 to 40. The default value is 1 (min) to 40 (max) to decode all standard-QR-Code-versions. More...
 
int MinVersionStandardQr () const
 Limiting values for standard-QR-code ranging from 1 to 40. The default value is 1 (min) to 40 (max) to decode all standard-QR-Code-versions. More...
 
void SetSubTypes (QrSubType subTypes)
 Determine which varieties of QR codes to read. More...
 
QrSubType SubTypes () const
 Returns which varieties of QR codes to read. More...
 
- Public Member Functions inherited from Reader2DWithQuietzoneConfigBase
void SetCheckQuietzone (bool checkQuietzone)
 Check/ignore quiet zone. More...
 
bool CheckQuietzone () const
 Return whether to check/ignore quiet zone. More...
 
- Public Member Functions inherited from Reader2DConfigBase
void SetMirrored (bool mirrored)
 Sets whether the code is mirrored/not mirrored. More...
 
bool Mirrored () const
 Returns whether the code is mirrored/not mirrored. More...
 
- Public Member Functions inherited from ReaderConfigBase
void SetInverse (bool inverse)
 Code is inverted (white on black)/not inverted. More...
 
bool Inverse () const
 Returns whether the code is inverted (white on black) or not. More...
 

Static Public Member Functions

static std::unique_ptr< QrFromHandle (const HandleGuard< ReaderConfig > &guard, bool &isActiveOut)
 Create object from handle. More...
 

Protected Attributes

const short MinVersionMiniQRLowest_ = 1
 Lowest possible version for mini QR reading.
 
const short MaxVersionMiniQRHighest_ = 4
 Highest possible version for mini QR reading.
 
const short MinVersionStandardQRLowest_ = 1
 Lowest possible version for mini QR reading.
 
const short MaxVersionStandardQRHighest_ = 40
 Highest possible version for mini QR reading.
 

Detailed Description

Configuration to access parameters of Qr.

Member Function Documentation

◆ FromHandle()

static std::unique_ptr< Qr > FromHandle ( const HandleGuard< ReaderConfig > &  guard,
bool &  isActiveOut 
)
inlinestatic

Create object from handle.

Parameters
[in]guardHandle guard to read the configuration from.
[out]isActiveOutReturns the active state of the configuration in the handle.
Returns
unique pointer to object.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ MaxVersionMiniQr()

int MaxVersionMiniQr ( ) const
inline

Limiting values for Mini-QR-code ranging from 1 to 4. The default value is 1 (min) to 4 (max) to decode all Mini-QR-Code-versions.

Returns
The parameter for the limiting values minimum of versions 1 to 4 and maximum of versions 1 to 4 are used to limit the supported versions. If all values types should be decoded, the values are 1 and 4.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMaxVersionMiniQr

◆ MaxVersionStandardQr()

int MaxVersionStandardQr ( ) const
inline

Limiting values for standard-QR-code ranging from 1 to 40. The default value is 1 (min) to 40 (max) to decode all standard-QR-Code-versions.

Returns
The parameter for the limiting values minimum of versions 1 to 40 and maximum of versions 1 to 40 are used to limit the supported versions. If all values types should be decoded, the values are 1 and 40.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMaxVersionStandardQr

◆ MinVersionMiniQr()

int MinVersionMiniQr ( ) const
inline

Limiting values for Mini-QR-code ranging from 1 to 4. The default value is 1 (min) to 4 (max) to decode all Mini-QR-Code-versions.

Returns
maxVersionMiniQR The parameter for the limiting values minimum of versions 1 to 4 and maximum of versions 1 to 4 are used to limit the supported versions. If all values types should be decoded, the values are 1 and 4.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMinVersionMiniQr

◆ MinVersionStandardQr()

int MinVersionStandardQr ( ) const
inline

Limiting values for standard-QR-code ranging from 1 to 40. The default value is 1 (min) to 40 (max) to decode all standard-QR-Code-versions.

Returns
The parameter for the limiting values minimum of versions 1 to 40 and maximum of versions 1 to 40 are used to limit the supported versions. If all values types should be decoded, the values are 1 and 40.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMinVersionStandardQr

◆ SetMaxVersionMiniQr()

void SetMaxVersionMiniQr ( int  maxVersionMiniQR)
inline

Limiting values for Mini-QR-code ranging from 1 to 4. The default value is 1 (min) to 4 (max) to decode all Mini-QR-Code-versions.

Parameters
[in]maxVersionMiniQRThe parameter for the limiting values minimum of versions M1 to M4 and maximum of versions M1 to M4 are used to limit the supported versions. If all values types should be decoded, the values are 1 and 4.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MaxVersionMiniQr

◆ SetMaxVersionStandardQr()

void SetMaxVersionStandardQr ( int  maxVersionStandardQR)
inline

Limiting values for standard-QR-code ranging from 1 to 40. The default value is 1 (min) to 40 (max) to decode all standard-QR-Code-versions.

Parameters
[in]maxVersionStandardQRThe parameter for the limiting values minimum of versions 1 to 40 and maximum of versions 1 to 40 are used to limit the supported versions. If all values types should be decoded, the values are 1 and 40.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MaxVersionStandardQr

◆ SetMinVersionMiniQr()

void SetMinVersionMiniQr ( int  minVersionMiniQR)
inline

Limiting values for Mini-QR-code ranging from 1 to 4. The default value is 1 (min) to 4 (max) to decode all Mini-QR-Code-versions.

Parameters
[in]minVersionMiniQRThe parameter for the limiting values minimum of versions 1 to 4 and maximum of versions 1 to 4 are used to limit the supported versions. If all values types should be decoded, the values are 1 and 4.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MinVersionMiniQr

◆ SetMinVersionStandardQr()

void SetMinVersionStandardQr ( int  minVersionStandardQR)
inline

Limiting values for standard-QR-code ranging from 1 to 40. The default value is 1 (min) to 40 (max) to decode all standard-QR-Code-versions.

Parameters
[in]minVersionStandardQRThe parameter for the limiting values minimum of versions 1 to 40 and maximum of versions 1 to 40 are used to limit the supported versions. If all values types should be decoded, the values are 1 and 40.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MinVersionStandardQr

◆ SetSubTypes()

void SetSubTypes ( QrSubType  subTypes)
inline

Determine which varieties of QR codes to read.

Parameters
[in]subTypesDetermine which varieties of QR codes to read.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SubTypes

◆ SubTypes()

QrSubType SubTypes ( ) const
inline

Returns which varieties of QR codes to read.

Returns
The varieties of QR codes to read.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetSubTypes