CVB++ 14.0
FourStateKix Class Reference

Configuration to access parameters of FourStateKix. More...

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

Inherits ReaderFourStateConfigBase.

Public Member Functions

void SetLsbPosition (FourStateLsb lsb)
 Sets the position of the "low significant bit" of the code in the image. More...
 
FourStateLsb LsbPosition () const
 Returns the position of the "low significant bit" of the code in the image. More...
 
void SetMinDigits (int minDigits)
 Sets the minimum number of the 4-State Kix code words. More...
 
int MinDigits () const
 Returns the minimum number of the 4-State Kix code words. More...
 
void SetMaxDigits (int maxDigits)
 Sets the maximum number of the 4-State Kix code words. More...
 
int MaxDigits () const
 Returns the maximum number of the 4-State Kix code words. 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< FourStateKixFromHandle (const HandleGuard< ReaderConfig > &guard, bool &isActiveOut)
 Create object from handle. More...
 

Detailed Description

Configuration to access parameters of FourStateKix.

Member Function Documentation

◆ FromHandle()

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

◆ LsbPosition()

FourStateLsb LsbPosition ( ) const
inline

Returns the position of the "low significant bit" of the code in the image.

Returns
The lsb "low significant bit" can be FourStateLsb::Left , FourStateLsb::Bottom, FourStateLsb::Right or FourStateLsb::Top. If the lsb is not correct (for example FourStateLsb::Left and FourStateLsb::Right are interchanged) the code interpretation is another. Default lsb = FourStateLsb::Left.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetLsbPosition

◆ MaxDigits()

int MaxDigits ( ) const
inline

Returns the maximum number of the 4-State Kix code words.

Returns
The MinDigits() and MaxDigits() parameters limit the number of code words for the 4-State Kix Postal Code. In general, this number is not identical to the number of coded data digits. The parameters do not take account of any start and stop digits which may have been transmitted. The size is between 6 and 18 digits.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMaxDigits

◆ MinDigits()

int MinDigits ( ) const
inline

Returns the minimum number of the 4-State Kix code words.

Returns
The MinDigits() and MaxDigits() parameters limit the number of code words for the 4-State Kix Postal Code. In general, this number is not identical to the number of coded data digits. The parameters do not take account of any start and stop digits which may have been transmitted. The size is between 6 and 18 digits.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMinDigits

◆ SetLsbPosition()

void SetLsbPosition ( FourStateLsb  lsb)
inline

Sets the position of the "low significant bit" of the code in the image.

Parameters
[in]lsbThe lsb "low significant bit" can be FourStateLsb::Left , FourStateLsb::Bottom, FourStateLsb::Right or FourStateLsb::Top. If the lsb is not correct (for example FourStateLsb::Left and FourStateLsb::Right are interchanged) the code interpretation is another. Default lsb = FourStateLsb::Left.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
LsbPosition

◆ SetMaxDigits()

void SetMaxDigits ( int  maxDigits)
inline

Sets the maximum number of the 4-State Kix code words.

Parameters
[in]maxDigitsThe MinDigits() and maxDigits parameters limit the number of code words for the 4-State Kix Postal Code. In general, this number is not identical to the number of coded data digits. The parameters do not take account of any start and stop digits which may have been transmitted. The size is between 6 and 18 digits.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MaxDigits

◆ SetMinDigits()

void SetMinDigits ( int  minDigits)
inline

Sets the minimum number of the 4-State Kix code words.

Parameters
[in]minDigitsThe minDigits and MaxDigits() parameters limit the number of code words for the 4-State Kix Postal Code. In general, this number is not identical to the number of coded data digits. The parameters do not take account of any start and stop digits which may have been transmitted. The size is between 6 and 18 digits.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MinDigits