CVBpy 15.0
FourStateRoyalMail Class Reference

Configuration to access parameters of FourStateRoyalMail. More...

Inherits ReaderFourStateConfigBase.

Properties

 evaluate_check_digit = property
 bool: Evaluate/ignore check digit. More...
 
 max_digits = property
 int: Maximum number of the 4-State Kix code words. More...
 
 min_digits = property
 int: Minimum number of the 4-State Kix code words. More...
 
 orientation = property
 int: Direction of the 4-State Royal Mail in the picture (see cvb.barcode.CodeOrientation). More...
 
 transmit_check_digit = property
 bool: Whether to append check digit to data. More...
 
 transmit_start_stop = property
 bool: Whether to transmit start and stop digits with data. More...
 

Detailed Description

Configuration to access parameters of FourStateRoyalMail.

Property Documentation

◆ evaluate_check_digit

evaluate_check_digit = property
static

bool: Evaluate/ignore check digit.

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.

◆ max_digits

max_digits = property
static

int: Maximum number of the 4-State Kix code words.

The FourStateLsb.min_digits and FourStateLsb.max_digits parameters limit the number of code words for the 4-State Kix 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 6 and 18 digits.

◆ min_digits

min_digits = property
static

int: Minimum number of the 4-State Kix code words.

The FourStateLsb.min_digits and FourStateLsb.max_digits parameters limit the number of code words for the 4-State Kix 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 6 and 18 digits.

◆ orientation

orientation = property
static

int: Direction of the 4-State Royal Mail in the picture (see cvb.barcode.CodeOrientation).

Direction in which the 4-State Royal Mail is in the image. There are three possible directions.

◆ transmit_check_digit

transmit_check_digit = property
static

bool: Whether to append check digit to data.

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 FourStateRoyalMail.transmit_check_digit = false.

◆ transmit_start_stop

transmit_start_stop = property
static

bool: Whether to transmit start and stop digits with data.

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.