Configuration to access parameters of FourStateRoyalMail (4-State RoyalMail Postal Code).
More...
#include <cvb/barcode/_detail/four_state_royal_mail.hpp>
Inherits ReaderFourStateConfigBase.
Configuration to access parameters of FourStateRoyalMail (4-State RoyalMail Postal Code).
◆ 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
-
- See also
- SetEvaluateCheckDigit
◆ FromHandle()
Create object from handle.
- Parameters
-
[in] | guard | Handle guard to read the configuration from. |
[out] | isActiveOut | Returns the active state of the configuration in the handle. |
- Returns
- unique pointer to object.
- Exceptions
-
◆ MaxDigits()
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
-
- See also
- SetMaxDigits
◆ MinDigits()
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
-
- See also
- SetMinDigits
◆ Orientation()
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
-
- See also
- SetOrientation
◆ SetEvaluateCheckDigit()
void SetEvaluateCheckDigit |
( |
bool |
evalCheckDigit | ) |
|
|
inline |
Sets whether to evaluate/ignore check digit.
- Parameters
-
[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. |
- Exceptions
-
- See also
- EvaluateCheckDigit
◆ SetMaxDigits()
void SetMaxDigits |
( |
int |
maxDigits | ) |
|
|
inline |
Sets the maximum number of the 4-State Royal Mail code words.
- Parameters
-
[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. |
- Exceptions
-
- See also
- MaxDigits
◆ SetMinDigits()
void SetMinDigits |
( |
int |
minDigits | ) |
|
|
inline |
Sets the minimum number of the 4-State Royal Mail code words.
- Parameters
-
[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. |
- Exceptions
-
- See also
- MinDigits
◆ SetOrientation()
Sets the direction of the 4-State Royal Mail in the picture.
- Parameters
-
[in] | orientation | It sets the direction in which the 4-State Royal Mail is in the image. There are three possible directions. |
- Exceptions
-
- See also
- Orientation
◆ SetTransmitCheckDigit()
void SetTransmitCheckDigit |
( |
bool |
transmitCheckDigit | ) |
|
|
inline |
Sets whether to append check digit to data.
- Parameters
-
[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. |
- Exceptions
-
- See also
- TransmitCheckDigit
◆ SetTransmitStartStop()
void SetTransmitStartStop |
( |
bool |
transmitStartStop | ) |
|
|
inline |
Sets whether to transmit start and stop digits with data.
- Parameters
-
[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. |
- Exceptions
-
- 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
-
- 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
-
- See also
- SetTransmitStartStop