Variables
Properties of 4-State Royal Mail Code

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.
 

Detailed Description

Variable Documentation

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.

Parameters
[in,out]Code4StateRoyalMailCheckDigitEvaluate/ignore check digit of the code.
Returns
Status of check digit flag.
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.

Parameters
[in,out]Code4StateRoyalMailDirectionSet the direction of the code.
Returns
Current direction.
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.

Parameters
[in,out]Code4StateRoyalMailInvertedCode is inverted (white on black)/not inverted.
Returns
Status of inverted flag.
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.

Parameters
[in,out]Code4StateRoyalMailMaxDigitsSet the maximum number of code words.
Returns
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.

Parameters
[in,out]Code4StateRoyalMailMinDigitsSet the minimum number of code words.
Returns
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.

Parameters
[in,out]Code4StateRoyalMailMirrorCode is mirrored/not mirrored.
Returns
Status of mirror flag.
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.

Parameters
[in,out]Code4StateRoyalMailQuietzoneSet the quiet zone in module width.
Returns
Quiet zone in modulwidth.
short Code4StateRoyalMailThreshold

Digitalisation threshold.

The property threshold sets the current digitalisation threshold in % ranging from 0 to 100. Default threshold is 10.

Parameters
[in,out]Code4StateRoyalMailThresholdSet the digitalisation threshold of the code.
Returns
Digitalisation threshold.
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.

Parameters
[in,out]Code4StateRoyalMailTransmitCheckDigitAppend/do not append a check digit to the code.
Returns
Status of check digit transmission flag.
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.

Parameters
[in,out]Code4StateRoyalMailTransmitStartStopTransmit/do not transmit start and stop digits.
Returns
Status of the transmission start stop flag.