RoyalMail Class Reference

Configuration class for Royal Mail codes. More...

Public Member Functions
cvb.code_reader.RoyalMail	disable (self)
	Disables decoding.
cvb.code_reader.RoyalMail	enable (self)
	Enables decoding.

Properties
	is_enabled = property
	bool: Indicates whether decoding for this symbology is enabled.
	is_send_check_character_enabled = property
	bool: Gets or sets adding check character to decoded data.

Detailed Description

Configuration class for Royal Mail codes.

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

decoder = cvb.code_reader.Decoder.create()
decoder.config(cvb.code_reader.Symbology.RoyalMail).enable()

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()

cvb.code_reader.RoyalMail disable

(

self

)

Disables decoding.

Returns

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

enable()

cvb.code_reader.RoyalMail enable

(

self

)

Enables decoding.

Returns

cvb.code_reader.RoyalMail 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_send_check_character_enabled

is_send_check_character_enabled = property

static

bool: Gets or sets adding check character to decoded data.

True if the adding check character is enabled, False otherwise.