UpcA Class Reference

Configuration class for UPC-A codes. More...

Public Member Functions
cvb.code_reader.UpcA	disable (self)
	Disables decoding.
cvb.code_reader.UpcA	disable_cca (self)
	Disables CompositeComponent A (CC-A) decoding.
cvb.code_reader.UpcA	disable_ccb (self)
	Disables CompositeComponent B (CC-B) decoding.
cvb.code_reader.UpcA	disable_ccc (self)
	Disables CompositeComponent C (CC-C) decoding.
cvb.code_reader.UpcA	enable (self)
	Enables decoding.
cvb.code_reader.UpcA	enable_cca (self)
	Enables CompositeComponent A (CC-A) decoding.
cvb.code_reader.UpcA	enable_ccb (self)
	Enables CompositeComponent B (CC-B) decoding.
cvb.code_reader.UpcA	enable_ccc (self)
	Enables CompositeComponent C (CC-C) decoding.
cvb.code_reader.UpcA	set_supplemental (self, int supplement, bool required, bool addSpace)
	Configures supplemental code decoding.

Properties
	is_conversion_to_ean13_enabled = property
	bool: Gets or sets whether 12-digit UPC-A codes are converted to 13-digit EAN-13 codes.
	is_enabled = property
	bool: Indicates whether decoding for this symbology is enabled.
	is_enabled_cca = property
	bool: Checks if CompositeComponent A (CC-A) decoding is enabled.
	is_enabled_ccb = property
	bool: Checks if CompositeComponent B (CC-B) decoding is enabled.
	is_enabled_ccc = property
	bool: Checks if CompositeComponent C (CC-C) decoding is enabled.
	is_strip_check_digit_enabled = property
	bool: Gets or sets whether the check digit is removed from read codes.
	is_strip_number_system_digit_enabled = property
	bool: Gets or sets whether UPC-A Number System digit is removed.
	supplemental = property
	int: The type of supplemental code to decode (see cvb.code_reader.SupplementalCode).

Detailed Description

Configuration class for UPC-A codes.

Use this class to configure decoding options for UPC-A codes. To access the configuration and enable decoding UPC-A 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.UpcA).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.UpcA disable

(

self

)

Disables decoding.

Returns

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

disable_cca()

cvb.code_reader.UpcA disable_cca

(

self

)

Disables CompositeComponent A (CC-A) decoding.

Disabling CC-A also deactivates it for all symbologies in the GS1 DataBar family.

Returns

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

disable_ccb()

cvb.code_reader.UpcA disable_ccb

(

self

)

Disables CompositeComponent B (CC-B) decoding.

Disabling CC-B also deactivates it for all symbologies in the GS1 DataBar family.

Returns

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

disable_ccc()

cvb.code_reader.UpcA disable_ccc

(

self

)

Disables CompositeComponent C (CC-C) decoding.

Disabling CC-C also deactivates it for all symbologies in the GS1 DataBar family.

Returns

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

enable()

cvb.code_reader.UpcA enable

(

self

)

Enables decoding.

Returns

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

enable_cca()

cvb.code_reader.UpcA enable_cca

(

self

)

Enables CompositeComponent A (CC-A) decoding.

Enabling CC-A also activates it for all symbologies in the GS1 DataBar family.

Returns

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

enable_ccb()

cvb.code_reader.UpcA enable_ccb

(

self

)

Enables CompositeComponent B (CC-B) decoding.

Enabling CC-B also activates it for all symbologies in the GS1 DataBar family.

Returns

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

enable_ccc()

cvb.code_reader.UpcA enable_ccc

(

self

)

Enables CompositeComponent C (CC-C) decoding.

Enabling CC-C also activates it for all symbologies in the GS1 DataBar family.

Returns

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

set_supplemental()

cvb.code_reader.UpcA set_supplemental	(		self,
		int	supplement,
		bool	required,
		bool	addSpace )

Configures supplemental code decoding.

Parameters

supplement : int Specifies the type of supplemental code to decode.

required : bool If set to True, the code will not be decoded unless both the code and the supplemental code are successfully decoded. If False, decoding the main code does not require the presence of a supplemental code.

addSpace : bool Enables or disables adding a space character between the code and the supplemental code.

Returns

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

Property Documentation

is_conversion_to_ean13_enabled

is_conversion_to_ean13_enabled = property

static

bool: Gets or sets whether 12-digit UPC-A codes are converted to 13-digit EAN-13 codes.

True if the conversion is enabled, False otherwise. Note, enabling this option will also activate the detection of EAN-13 codes.

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_enabled_cca

is_enabled_cca = property

static

bool: Checks if CompositeComponent A (CC-A) decoding is enabled.

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

is_enabled_ccb

is_enabled_ccb = property

static

bool: Checks if CompositeComponent B (CC-B) decoding is enabled.

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

is_enabled_ccc

is_enabled_ccc = property

static

bool: Checks if CompositeComponent C (CC-C) decoding is enabled.

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

is_strip_check_digit_enabled

is_strip_check_digit_enabled = property

static

bool: Gets or sets whether the check digit is removed from read codes.

True if the check digit is removed, otherwise, False.

is_strip_number_system_digit_enabled

is_strip_number_system_digit_enabled = property

static

bool: Gets or sets whether UPC-A Number System digit is removed.

True if the removal is enabled, False otherwise.