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... | |
virtual Symbology | Type () const override |
Symbology of configuration object. 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... | |
Public Member Functions inherited from ConfigBase | |
virtual bool | ReadFromHandle (const HandleGuard< ReaderConfig > &guard) |
Read configuration parameters from handle. More... | |
virtual void | WriteToHandle (bool active, HandleGuard< ReaderConfig > &guard) |
Write configuration parameters into handle. More... | |
Static Public Member Functions | |
static std::unique_ptr< FourStateRoyalMail > | FromHandle (const HandleGuard< ReaderConfig > &guard, bool &isActiveOut) |
Create object from handle. More... | |
Configuration to access parameters of FourStateRoyalMail (4-State RoyalMail Postal Code).
|
inline |
Returns whether to evaluate/ignore check digit.
Any | exception derived from std::exception including CvbException. |
|
inlinestatic |
Create object from handle.
[in] | guard | Handle guard to read the configuration from. |
[out] | isActiveOut | Returns the active state of the configuration in the handle. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the maximum number of the 4-State Royal Mail code words.
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the minimum number of the 4-State Royal Mail code words.
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the direction of the 4-State Royal Mail in the picture.
Any | exception derived from std::exception including CvbException. |
|
inline |
Sets whether to evaluate/ignore check digit.
[in] | evalCheckDigit | It activates or deactivates the checking of any check digit which may be present. Specifying true activates checking; specifying false deactivates checking. Default is true. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Sets the maximum number of the 4-State Royal Mail code words.
[in] | maxDigits | The 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. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Sets the minimum number of the 4-State Royal Mail code words.
[in] | minDigits | The 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. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Sets the direction of the 4-State Royal Mail in the picture.
[in] | orientation | It sets the direction in which the 4-State Royal Mail is in the image. There are three possible directions. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Sets whether to append check digit to data.
[in] | transmitCheckDigit | If 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. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Sets whether to transmit start and stop digits with data.
[in] | transmitStartStop | It 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. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns whether to append check digit to data.
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns whether to transmit start and stop digits with data.
Any | exception derived from std::exception including CvbException. |
|
inlineoverridevirtual |
Symbology of configuration object.
Any | exception derived from std::exception including CvbException. |
Implements ConfigBase.