CVB++ 14.0
FourStateAustralian Class Reference

Configuration to access parameters of FourStateAustralian (4-State Australian). More...

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

Inherits ReaderFourStateConfigBase.

Public Member Functions

void SetLevels (FourStateAustralianLevels levels)
 Bit field which specifies the permitted subtypes of the 4-State Australian. More...
 
FourStateAustralianLevels Levels () const
 Returns the bit field which specifies the permitted subtypes of the 4-State Australian. More...
 
void SetOrientation (CodeOrientation orientation)
 Direction of the 4-State Australian in the image. More...
 
CodeOrientation Orientation () const
 Returns the direction of the 4-State Australian in the image. More...
 
- Public Member Functions inherited from ReaderFourStateConfigBase
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...
 
void SetQuietzoneWidth (int quietzoneWidth)
 Sets the quiet zone in module width. More...
 
int QuietzoneWidth () const
 Returns the quiet zone in module width. More...
 
void SetThreshold (int threshold)
 Sets the digitalisation threshold in percent, ranging from 0 to 100. More...
 
int Threshold () const
 Returns the digitalisation threshold in percent, ranging from 0 to 100. 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< FourStateAustralianFromHandle (const HandleGuard< ReaderConfig > &guard, bool &isActiveOut)
 Create object from handle. More...
 

Detailed Description

Configuration to access parameters of FourStateAustralian (4-State Australian).

Member Function Documentation

◆ FromHandle()

static std::unique_ptr< FourStateAustralian > 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()

FourStateAustralianLevels Levels ( ) const
inline

Returns the bit field which specifies the permitted subtypes of the 4-State Australian.

Returns
The 4-State Australian has various subtypes you can choose. You can use a bitwise OR combination of the constants.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetLevels

◆ Orientation()

CodeOrientation Orientation ( ) const
inline

Returns the direction of the 4-State Australian in the image.

Returns
The return value gives the direction, in which the 4-State Australian is in the image. There are three possible directions.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetOrientation

◆ SetLevels()

void SetLevels ( FourStateAustralianLevels  levels)
inline

Bit field which specifies the permitted subtypes of the 4-State Australian.

Parameters
[in]levelsThe 4-State Australian has various subtypes you can choose. You can use a bitwise OR combination of the constants.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
Levels

◆ SetOrientation()

void SetOrientation ( CodeOrientation  orientation)
inline

Direction of the 4-State Australian in the image.

Parameters
[in]orientationThis parameter sets the direction, in which the 4-State Australian is in the image. There are three possible directions.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
Orientation