Variables
Properties of 4-State Australian Code

Variables

short Code4StateAustralianDirection
 Direction of the 4-State Australian in the image.
 
bool Code4StateAustralianInverted
 Code is inverted (white on black) /not inverted.
 
short Code4StateAustralianLevels
 Bit field which specifies the permitted subtypes of the 4-State Australian.
 
bool Code4StateAustralianMirror
 Code is mirrored/not mirrored.
 
short Code4StateAustralianQuietzone
 The Quiet zone in module width.
 
short Code4StateAustralianThreshold
 Digitalisation threshold.
 

Detailed Description

Variable Documentation

short Code4StateAustralianDirection

Direction of the 4-State Australian in the image.

The property direction sets the current direction of the 4-State Australian Postal code 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]Code4StateAustralianDirectionSet the direction of the code.
Returns
Current direction.
bool Code4StateAustralianInverted

Code is inverted (white on black) /not inverted.

The property 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, pass the value TRUE.

Parameters
[in,out]Code4StateAustralianInvertedCode is inverted/not inverted.
Returns
Status of inverted flag.
short Code4StateAustralianLevels

Bit field which specifies the permitted subtypes of the 4-State Australian.

The 4-State Australian has various subtypes which can be set. The subtypes are set via a bitwise OR combination of the constants:

  • CVC_BC_FOUR_STATE_AUSTRALIAN_NO_LEVELS.
  • CVC_BC_FOUR_STATE_AUSTRALIAN_STANDARD_CUSTOMER_BARCODE.
  • CVC_BC_FOUR_STATE_AUSTRALIAN_ROUTING_BARCODE.
  • CVC_BC_FOUR_STATE_AUSTRALIAN_REPLY_PAID_BARCODE.
  • CVC_BC_FOUR_STATE_AUSTRALIAN_REDIRECTION_BARCODE.
  • CVC_BC_FOUR_STATE_AUSTRALIAN_CUSTOMER_BARCODE_2.
  • CVC_BC_FOUR_STATE_AUSTRALIAN_CUSTOMER_BARCODE_3.
  • CVC_BC_FOUR_STATE_AUSTRALIAN_ALL_LEVELS.
Parameters
[in,out]Code4StateAustralianLevelsSet the permitted subtypes of the code.
Returns
Bit field which specifies the permitted subtypes.
bool Code4StateAustralianMirror

Code is mirrored/not mirrored.

The property mirror = TRUE specifies that the 4-State Australian is mirrored, possibly because the code must be read from the rear or because it was mirrored on image acquisition.

Parameters
[in,out]Code4StateAustralianMirrorCode is mirrored/not mirrored.
Returns
Status of mirror flag.
short Code4StateAustralianQuietzone

The Quiet zone in module width.

The property quietzone sets the minimal quiet zone in module width. The range is between 2 to 10. Default quiet zone is 5.

Parameters
[in,out]Code4StateAustralianQuietzoneCheck/ignore quiet zone.
Returns
Status of the quiet zone.
short Code4StateAustralianThreshold

Digitalisation threshold.

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

Parameters
[in,out]Code4StateAustralianThresholdSet the digitalisation threshold of the code.
Returns
Digitalisation threshold.