CVBpy 15.0
Loading...
Searching...
No Matches
AustraliaPost Class Reference

Configuration class for Australia Post codes. More...

Public Member Functions

cvb.code_reader.AustraliaPost disable (self)
 Disables decoding.
 
cvb.code_reader.AustraliaPost enable (self)
 Enables decoding.
 

Properties

 is_enabled = property
 bool: Indicates whether decoding for this symbology is enabled.
 
 is_strip_check_characters_enabled = property
 bool: Gets or sets the removal of check characters from decoded data.
 

Detailed Description

Configuration class for Australia Post codes.

Use this class to configure decoding options for Australia Post codes. To access the configuration and enable decoding Australia Post codes, use the following example. For additional details on configuration, refer to the documentation for Decoder.config().

decoder.config(cvb.code_reader.Symbology.AustraliaPost).enable()
cvb.code_reader.Decoder create()
Creates and returns a new decoder object.
Definition __init__.py:496

A more comprehensive code example demonstrating configuration in a broader context, as well as the decoding process, can be found here.

Member Function Documentation

◆ disable()

Disables decoding.

Returns

cvb.code_reader.AustraliaPost A reference to the current configuration object for method chaining.

◆ enable()

Enables decoding.

Returns

cvb.code_reader.AustraliaPost A reference to the current configuration object for method chaining.

Property Documentation

◆ is_enabled

is_enabled = property
static

bool: Indicates whether decoding for this symbology is enabled.

Can be used to check the status or to enable/disable decoding directly.True if decoding is enabled, False otherwise.

◆ is_strip_check_characters_enabled

is_strip_check_characters_enabled = property
static

bool: Gets or sets the removal of check characters from decoded data.

True if the removal of check characters from decoded data is enabled, False otherwise.