Configuration class for UPC-E codes. More...
Public Member Functions | |
cvb.code_reader.UpcE | disable (self) |
Disables decoding. | |
cvb.code_reader.UpcE | disable_cca (self) |
Disables CompositeComponent A (CC-A) decoding. | |
cvb.code_reader.UpcE | disable_ccb (self) |
Disables CompositeComponent B (CC-B) decoding. | |
cvb.code_reader.UpcE | disable_ccc (self) |
Disables CompositeComponent C (CC-C) decoding. | |
cvb.code_reader.UpcE | enable (self) |
Enables decoding. | |
cvb.code_reader.UpcE | enable_cca (self) |
Enables CompositeComponent A (CC-A) decoding. | |
cvb.code_reader.UpcE | enable_ccb (self) |
Enables CompositeComponent B (CC-B) decoding. | |
cvb.code_reader.UpcE | enable_ccc (self) |
Enables CompositeComponent C (CC-C) decoding. | |
cvb.code_reader.UpcE | set_supplemental (self, int supplement, bool required, bool addSpace) |
Configures supplemental code decoding. | |
Properties | |
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_reject_misread_code_enabled = property | |
bool: Configuration for handling of damaged UPCE-A and EAN-13 codes. | |
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-E Number System digit is removed. | |
is_upc_e1_enabled = property | |
bool: Gets or sets whether UPC-E1 decoding is enabled. | |
is_upc_e_expansion_enabled = property | |
bool: Gets or sets whether the expansion of detected UPC-E codes to the UPC-A format is enabled. | |
supplemental = property | |
int: The type of supplemental code to decode (see cvb.code_reader.SupplementalCode). | |
Configuration class for UPC-E codes.
Use this class to configure decoding options for UPC-E codes. To access the configuration and enable decoding UPC-E codes, use the following example. For additional details on configuration, refer to the documentation for Decoder.config().
A more comprehensive code example demonstrating configuration in a broader context, as well as the decoding process, can be found here.
cvb.code_reader.UpcE disable | ( | self | ) |
Disables decoding.
cvb.code_reader.UpcE A reference to the current configuration object for method chaining.
cvb.code_reader.UpcE disable_cca | ( | self | ) |
Disables CompositeComponent A (CC-A) decoding.
Disabling CC-A also deactivates it for all symbologies in the GS1 DataBar family.
cvb.code_reader.UpcE A reference to the current configuration object for method chaining.
cvb.code_reader.UpcE disable_ccb | ( | self | ) |
Disables CompositeComponent B (CC-B) decoding.
Disabling CC-B also deactivates it for all symbologies in the GS1 DataBar family.
cvb.code_reader.UpcE A reference to the current configuration object for method chaining.
cvb.code_reader.UpcE disable_ccc | ( | self | ) |
Disables CompositeComponent C (CC-C) decoding.
Disabling CC-C also deactivates it for all symbologies in the GS1 DataBar family.
cvb.code_reader.UpcE A reference to the current configuration object for method chaining.
cvb.code_reader.UpcE enable | ( | self | ) |
Enables decoding.
cvb.code_reader.UpcE A reference to the current configuration object for method chaining.
cvb.code_reader.UpcE enable_cca | ( | self | ) |
Enables CompositeComponent A (CC-A) decoding.
Enabling CC-A also activates it for all symbologies in the GS1 DataBar family.
cvb.code_reader.UpcE A reference to the current configuration object for method chaining.
cvb.code_reader.UpcE enable_ccb | ( | self | ) |
Enables CompositeComponent B (CC-B) decoding.
Enabling CC-B also activates it for all symbologies in the GS1 DataBar family.
cvb.code_reader.UpcE A reference to the current configuration object for method chaining.
cvb.code_reader.UpcE enable_ccc | ( | self | ) |
Enables CompositeComponent C (CC-C) decoding.
Enabling CC-C also activates it for all symbologies in the GS1 DataBar family.
cvb.code_reader.UpcE A reference to the current configuration object for method chaining.
cvb.code_reader.UpcE set_supplemental | ( | self, | |
int | supplement, | ||
bool | required, | ||
bool | addSpace ) |
Configures supplemental code decoding.
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.
cvb.code_reader.UpcE A reference to the current configuration object for method chaining.
|
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.
|
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.
|
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.
|
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.
|
static |
bool: Configuration for handling of damaged UPCE-A and EAN-13 codes.
This setting prevents damaged UPC-A or EAN-13 barcodes from being misinterpreted as UPC-E. Enabling this option ensures greater decoding accuracy by rejecting such misreads. This property has to be set to True
to reject damaged UPC-A or EAN-13 barcodes that could be misread as UPC-E, and to False
to allow decoding of such damaged barcodes as UPC-E.
|
static |
bool: Gets or sets whether the check digit is removed from read codes.
True
if the check digit is removed, otherwise, False
.
|
static |
bool: Gets or sets whether UPC-E Number System digit is removed.
True
if the removal is enabled, False
otherwise.
|
static |
bool: Gets or sets whether UPC-E1 decoding is enabled.
True
if the UPC-E1 is enabled, False
otherwise.
|
static |
bool: Gets or sets whether the expansion of detected UPC-E codes to the UPC-A format is enabled.
True
if the expansion of detected UPC-E codes to the UPC-A format is enabled, False
otherwise.
We use cookies to improve your experience. By using this documentation, you agree to our use of cookies.