CVB++ 15.0
Pdf417 Class Reference

Configuration to access parameters of Pdf417. More...

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

Inherits Reader2DConfigBase.

Public Member Functions

void SetLevels (Pdf417Levels levels)
 Bit field which specifies the permitted error correction level. More...
 
Pdf417Levels Levels () const
 Returns the bit field which specifies the permitted error correction level. More...
 
void SetMinRows (int minRows)
 Sets the minimum number of data rows. More...
 
int MinRows () const
 Returns the minimum number of data rows. More...
 
void SetMaxRows (int maxRows)
 Sets the maximum number of data rows. More...
 
int MaxRows () const
 Returns the maximum number of data rows. More...
 
void SetMinColumns (int minColumns)
 Sets the minimum number of data columns. More...
 
int MinColumns () const
 Returns the minimum number of data columns. More...
 
void SetMaxColumns (int maxColumns)
 Sets the maximum number of data columns. More...
 
int MaxColumns () const
 Returns the maximum number of data columns. 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< Pdf417FromHandle (const HandleGuard< ReaderConfig > &guard, bool &isActiveOut)
 Create object from handle. More...
 

Detailed Description

Configuration to access parameters of Pdf417.

Member Function Documentation

◆ FromHandle()

static std::unique_ptr< Pdf417 > 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.

◆ Levels()

Pdf417Levels Levels ( ) const
inline

Returns the bit field which specifies the permitted error correction level.

Returns
The pdf_levels.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetLevels

◆ MaxColumns()

int MaxColumns ( ) const
inline

Returns the maximum number of data columns.

Returns
The maximum number of data columns.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMaxColumns

◆ MaxRows()

int MaxRows ( ) const
inline

Returns the maximum number of data rows.

Returns
The maximum number of data rows.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMaxRows

◆ MinColumns()

int MinColumns ( ) const
inline

Returns the minimum number of data columns.

Returns
The minimum number of data columns.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMinColumns

◆ MinRows()

int MinRows ( ) const
inline

Returns the minimum number of data rows.

Returns
The minimum number of data rows.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMinRows

◆ SetLevels()

void SetLevels ( Pdf417Levels  levels)
inline

Bit field which specifies the permitted error correction level.

Parameters
[in]levelsSpecify Pdf417Levels::All to enable decoding. You can use an OR combination of the constants Pdf417Levels::Level0 to Pdf417Levels::Level8 to permit any required combination of the possible error correction level for decoding.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
Levels

◆ SetMaxColumns()

void SetMaxColumns ( int  maxColumns)
inline

Sets the maximum number of data columns.

Parameters
[in]maxColumnsUse the MinRows() and MaxRows() or MinColumns() and MaxColumns() to restrict PDF 417 evaluation to certain sizes. Here the number specified for the columns refers to data columns only, for example start and stop codes as well left- and right-hand line indicators are not counted. Normally you can set these parameters to their default value.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MaxColumns

◆ SetMaxRows()

void SetMaxRows ( int  maxRows)
inline

Sets the maximum number of data rows.

Parameters
[in]maxRowsUse the MinRows() and MaxRows() or MinColumns() and MaxColumns() to restrict PDF 417 evaluation to certain sizes. Here the number specified for the columns refers to data columns only, for example start and stop codes as well left- and right-hand line indicators are not counted. Normally you can set these parameters to their default value.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MaxRows

◆ SetMinColumns()

void SetMinColumns ( int  minColumns)
inline

Sets the minimum number of data columns.

Parameters
[in]minColumnsUse the MinRows() and MaxRows() or MinColumns() and MaxColumns() to restrict PDF 417 evaluation to certain sizes. Here the number specified for the columns refers to data columns only, for example start and stop codes as well left- and right-hand line indicators are not counted. Normally you can set these parameters to their default value.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MinColumns

◆ SetMinRows()

void SetMinRows ( int  minRows)
inline

Sets the minimum number of data rows.

Parameters
[in]minRowsUse the MinRows() and MaxRows() or MinColumns() and MaxColumns() to restrict PDF 417 evaluation to certain sizes. Here the number specified for the columns refers to data columns only, for example start and stop codes as well left- and right-hand line indicators are not counted. Normally you can set these parameters to their default value.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MinRows