Variables | |
bool | Code4StateRoyalMailCheckDigit |
Evaluate/ignore check digit. | |
short | Code4StateRoyalMailDirection |
Direction of the 4-State Royal Mail in the picture. | |
bool | Code4StateRoyalMailInverted |
Code is inverted (white on black)/not inverted. | |
short | Code4StateRoyalMailMaxDigits |
Maximum number of the 4-State Royal Mail code words. | |
short | Code4StateRoyalMailMinDigits |
Minimum number of the 4-State Royal Mail code words. | |
bool | Code4StateRoyalMailMirror |
Code is mirrored/not mirrored. | |
short | Code4StateRoyalMailQuietzone |
Quiet zone in module width. | |
short | Code4StateRoyalMailThreshold |
Digitalisation threshold. | |
bool | Code4StateRoyalMailTransmitCheckDigit |
Append/do not append check digit to data. | |
bool | Code4StateRoyalMailTransmitStartStop |
Transmit/do not transmit start and stop digits with data. | |
bool Code4StateRoyalMailCheckDigit |
Evaluate/ignore check digit.
The checkDigit
property activates or deactivates the checking of any check digit which may be present. Specifying TRUE
activates checking; specifying FALSE
deactivates checking. Default check digit is TRUE
.
[in,out] | Code4StateRoyalMailCheckDigit | Evaluate/ignore check digit of the code. |
short Code4StateRoyalMailDirection |
Direction of the 4-State Royal Mail in the picture.
The property direction
sets the direction in which the 4-State Royal Mail is in the image. There are three directions possible: CVC_BC_FENCE
, CVC_BC_LADDER
, and CVC_BC_BOTH
. The default direction is CVC_BC_FENCE
.
[in,out] | Code4StateRoyalMailDirection | Set the direction of the code. |
bool Code4StateRoyalMailInverted |
Code is inverted (white on black)/not inverted.
The property inverted
set to TRUE
specifies whether the barcode is present as a black on white image (invers = FALSE
) or a white on black image (invers = TRUE
). Normally barcodes are printed dark on a bright background in which case the value FALSE
is passed. Under certain circumstances, the contrast ratio may be inverted. In such cases, the value TRUE
is passed.
[in,out] | Code4StateRoyalMailInverted | Code is inverted (white on black)/not inverted. |
short Code4StateRoyalMailMaxDigits |
Maximum number of the 4-State Royal Mail code words.
The properties min_digits
and max_digits
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.
[in,out] | Code4StateRoyalMailMaxDigits | Set the maximum number of code words. |
short Code4StateRoyalMailMinDigits |
Minimum number of the 4-State Royal Mail code words.
The properties min_digits
and max_digits
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.
[in,out] | Code4StateRoyalMailMinDigits | Set the minimum number of code words. |
bool Code4StateRoyalMailMirror |
Code is mirrored/not mirrored.
The property mirror
sets the current status of the mirror flag of the 4-State Royal Mail code. The property mirror = TRUE
specifies that the 4-State Royal Mail is mirrored, possibly because the code must be read from the rear or because it was mirrored on image acquisition.
[in,out] | Code4StateRoyalMailMirror | Code is mirrored/not mirrored. |
short Code4StateRoyalMailQuietzone |
Quiet zone in module width.
The property quietzone
sets the minimal quiet zone in module width. The range is 2 to 10. The default value is 5.
[in,out] | Code4StateRoyalMailQuietzone | Set the quiet zone in module width. |
short Code4StateRoyalMailThreshold |
Digitalisation threshold.
The property threshold
sets the current digitalisation threshold in % ranging from 0 to 100. Default threshold is 10.
[in,out] | Code4StateRoyalMailThreshold | Set the digitalisation threshold of the code. |
bool Code4StateRoyalMailTransmitCheckDigit |
Append/do not append check digit to data.
If necessary, the transmit_checkdigit
property activates or deactivates transmission of a check digit. Specifying TRUE
activates transmission; specifying FALSE
deactivates it. If check digit = FALSE
, this parameter is ignored. Default transmit_checkdigit is FALSE
.
[in,out] | Code4StateRoyalMailTransmitCheckDigit | Append/do not append a check digit to the code. |
bool Code4StateRoyalMailTransmitStartStop |
Transmit/do not transmit start and stop digits with data.
The property transmit_start_stop
activates or deactivates transmission of the start or stop digit. Specifying TRUE
activates transmission; specifying FALSE
deactivates it. The start/stop digits for the 4-State Royal Mail code are the start and stop characters '(' and ')'. Default transmit_start_stop is TRUE
.
[in,out] | Code4StateRoyalMailTransmitStartStop | Transmit/do not transmit start and stop digits. |