CVB++ 14.0
FourStateRoyalMail Class Reference

Configuration to access parameters of FourStateRoyalMail (4-State RoyalMail Postal Code). More...

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

Inherits ReaderFourStateConfigBase.

Public Member Functions

void SetEvaluateCheckDigit (bool evalCheckDigit)
 Sets whether to evaluate/ignore check digit. More...
 
bool EvaluateCheckDigit () const
 Returns whether to evaluate/ignore check digit. More...
 
void SetTransmitCheckDigit (bool transmitCheckDigit)
 Sets whether to append check digit to data. More...
 
bool TransmitCheckDigit () const
 Returns whether to append check digit to data. More...
 
void SetTransmitStartStop (bool transmitStartStop)
 Sets whether to transmit start and stop digits with data. More...
 
bool TransmitStartStop () const
 Returns whether to transmit start and stop digits with data. More...
 
void SetMinDigits (int minDigits)
 Sets the minimum number of the 4-State Royal Mail code words. More...
 
int MinDigits () const
 Returns the minimum number of the 4-State Royal Mail code words. More...
 
void SetMaxDigits (int maxDigits)
 Sets the maximum number of the 4-State Royal Mail code words. More...
 
int MaxDigits () const
 Returns the maximum number of the 4-State Royal Mail code words. More...
 
void SetOrientation (CodeOrientation orientation)
 Sets the direction of the 4-State Royal Mail in the picture. More...
 
CodeOrientation Orientation () const
 Returns the direction of the 4-State Royal Mail in the picture. 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< FourStateRoyalMailFromHandle (const HandleGuard< ReaderConfig > &guard, bool &isActiveOut)
 Create object from handle. More...
 

Detailed Description

Configuration to access parameters of FourStateRoyalMail (4-State RoyalMail Postal Code).

Member Function Documentation

◆ EvaluateCheckDigit()

bool EvaluateCheckDigit ( ) const
inline

Returns whether to evaluate/ignore check digit.

Returns
The return value activates or deactivates the checking of any check digit which may be present.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetEvaluateCheckDigit

◆ FromHandle()

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

◆ MaxDigits()

int MaxDigits ( ) const
inline

Returns the maximum number of the 4-State Royal Mail code words.

Returns
The MinDigits() and MaxDigits() values limit the number of code words for the 4-State RoyalMail 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 7 and 13 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 Royal Mail code words.

Returns
The MinDigits() and MaxDigits() values limit the number of code words for the 4-State RoyalMail 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 7 and 13 digits.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMinDigits

◆ Orientation()

CodeOrientation Orientation ( ) const
inline

Returns the direction of the 4-State Royal Mail in the picture.

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

◆ SetEvaluateCheckDigit()

void SetEvaluateCheckDigit ( bool  evalCheckDigit)
inline

Sets whether to evaluate/ignore check digit.

Parameters
[in]evalCheckDigitIt activates or deactivates the checking of any check digit which may be present. Specifying true activates checking; specifying false deactivates checking. Default is true.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
EvaluateCheckDigit

◆ SetMaxDigits()

void SetMaxDigits ( int  maxDigits)
inline

Sets the maximum number of the 4-State Royal Mail code words.

Parameters
[in]maxDigitsThe MinDigits() and maxDigits parameters limit the number of code words for the 4-State RoyalMail 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 7 and 13 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 Royal Mail code words.

Parameters
[in]minDigitsThe minDigits and MaxDigits() parameters limit the number of code words for the 4-State RoyalMail 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 7 and 13 digits.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MinDigits

◆ SetOrientation()

void SetOrientation ( CodeOrientation  orientation)
inline

Sets the direction of the 4-State Royal Mail in the picture.

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

◆ SetTransmitCheckDigit()

void SetTransmitCheckDigit ( bool  transmitCheckDigit)
inline

Sets whether to append check digit to data.

Parameters
[in]transmitCheckDigitIf necessary, the parameter activates or deactivates transmission of a check digit. Specifying true activates transmission; specifying false deactivates it. If EvaluateCheckDigit() is false, this parameter is ignored. Default transmitCheckDigit = false.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
TransmitCheckDigit

◆ SetTransmitStartStop()

void SetTransmitStartStop ( bool  transmitStartStop)
inline

Sets whether to transmit start and stop digits with data.

Parameters
[in]transmitStartStopIt activates or deactivates transmission of the start or stop digit. Specifying true activates transmission; specifying false deactivates it. The start/stop digits for 4-State Royal Mail are the start and stop characters '(' and ')'. Default is true.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
TransmitStartStop

◆ TransmitCheckDigit()

bool TransmitCheckDigit ( ) const
inline

Returns whether to append check digit to data.

Returns
The return value tells whether it activates or deactivates transmission of a check digit.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetTransmitCheckDigit

◆ TransmitStartStop()

bool TransmitStartStop ( ) const
inline

Returns whether to transmit start and stop digits with data.

Returns
The return value tells whether it activates or deactivates transmission of the start or stop digit.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetTransmitStartStop