CVB++ 15.0
MicroPdf417 Class Reference

Configuration to access parameters of MicroPdf417. More...

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

Inherits Reader2DWithQuietzoneConfigBase.

Public Member Functions

void SetOrientation (CodeOrientation orientation)
 Specifies the orientation of the code in the image. More...
 
CodeOrientation Orientation () const
 Returns the orientation of the code in the image. 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< MicroPdf417FromHandle (const HandleGuard< ReaderConfig > &guard, bool &isActiveOut)
 Create object from handle. More...
 

Detailed Description

Configuration to access parameters of MicroPdf417.

Member Function Documentation

◆ FromHandle()

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

◆ Orientation()

CodeOrientation Orientation ( ) const
inline

Returns the orientation of the code in the image.

Returns
The return value tells the direction in which the MicroPDF 417 is in the picture. There are three possible directions: CodeOrientation::Fence, CodeOrientation::Ladder, and CodeOrientation::FenceOrLadder (The MicroPDF 417 may be present in either vertical or horizontal orientation, but not in an angle of rotation of 45 degrees).
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetOrientation

◆ SetOrientation()

void SetOrientation ( CodeOrientation  orientation)
inline

Specifies the orientation of the code in the image.

Parameters
[in]orientationThis parameter sets the direction in which the MicroPDF 417 is in the picture. There are three possible directions: CodeOrientation::Fence, CodeOrientation::Ladder, and CodeOrientation::FenceOrLadder (The MicroPDF 417 may be present in either vertical or horizontal orientation, but not in an angle of rotation of 45 degrees).
Exceptions
Anyexception derived from std::exception including CvbException.
See also
Orientation