Configuration class for UPC-E barcodes. More...

#include <cvb/config.hpp>

Public Member Functions
UpcE &	SetSupplemental (SupplementalCode supplement, bool required=false, bool addSpace=true) override
	Configures supplemental code decoding.

SupplementalCode	Supplemental () const override
	Retrieves the current configuration of the supplemental code decoding.

UpcE &	SetStripCheckDigit (bool value) override
	Enables or disables the removal of the check digit from read codes.

bool	StripCheckDigit () const override
	Determines whether check digit removal is enabled.

UpcE &	SetStripNumberSystemDigit (bool value)
	Enables or disables the removal of the UPC-E Number System digit from read codes.

bool	StripNumberSystemDigit () const
	Determines whether UPC-E Number System digit removal is enabled.

UpcE &	SetRejectMisreadCode (bool value)
	Configures handling of damaged UPCE-A and EAN-13 codes.

bool	RejectMisreadCode () const
	Determines whether damaged UPC-A or EAN-13 barcodes are rejected.

bool	EnabledUpcE1 () const
	Checks if UPC-E1 decoding is enabled.

UpcE &	SetEnableUpcE1 (bool value)
	Enables or disables UPC-E1 decoding.

bool	EnabledUpcEExpansion () const
	Determines if the expansion of detected UPC-E codes to the UPC-A format is enabled.

UpcE &	SetEnableUpcEExpansion (bool value)
	Enables or disables the expansion of detected UPC-E codes to the UPC-A format.

Public Member Functions inherited from UpcEanBase< UpcE >
virtual UpcE &	EnableCCA () override
	Enables Composite Component A (CC-A) decoding.

virtual UpcE &	DisableCCA () override
	Disables Composite Component A (CC-A) decoding.

virtual UpcE &	EnableCCB () override
	Enables Composite Component B (CC-B) decoding.

virtual UpcE &	DisableCCB () override
	Disables Composite Component B (CC-B) decoding.

virtual UpcE &	EnableCCC () override
	Enables Composite Component C (CC-C) decoding.

virtual UpcE &	DisableCCC () override
	Disables Composite Component C (CC-C) decoding.

Public Member Functions inherited from CompositeCodeBase< UpcE >
bool	EnabledCCA () const
	Checks if CompositeComponent A (CC-A) decoding is enabled.

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

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

Public Member Functions inherited from ConfigBase< UpcE >
bool	Enabled () const
	Checks if decoding for the code type represented by the derived class is enabled.

UpcE &	Enable ()
	Enables decoding for the code type represented by the derived class.

UpcE &	Disable ()
	Disables decoding for the code type represented by the derived class.

Friends
class	Cvb::CodeReader::Decoder

Detailed Description

Configuration class for UPC-E barcodes.

Use this class to configure decoding options for UPC-E barcodes. To access the configuration and enable decoding UPC-E barcodes, use the following example. For additional details on configuration, refer to the documentation for Decoder::Config().

auto decoder = Cvb::CodeReader::Decoder::Create();

decoder->Config<Cvb::CodeReader::Symbology::UpcE>().Enable();

Cvb::CodeReader::Decoder::Create

static std::unique_ptr< Decoder > Create()

Creates and returns a new Decoder instance.

Definition detail_decoder.hpp:22

Cvb::CodeReader::Config::Checksum::Enable

@ Enable

Enable checksum.

Definition decl_config_logistic_codes.hpp:19

Cvb::CodeReader::Symbology::UpcE

@ UpcE

UPC-E.

Definition decl_config_base.hpp:72

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

Member Function Documentation

◆ EnabledUpcE1()

bool EnabledUpcE1 ( ) const

inline

Checks if UPC-E1 decoding is enabled.

Returns: true if UPC-E1 decoding is enabled, false otherwise.

◆ EnabledUpcEExpansion()

bool EnabledUpcEExpansion ( ) const

inline

Determines if the expansion of detected UPC-E codes to the UPC-A format is enabled.

Returns: true if the expansion of detected UPC-E codes to the UPC-A format is enabled, false otherwise.

◆ RejectMisreadCode()

bool RejectMisreadCode ( ) const

inline

Determines whether damaged UPC-A or EAN-13 barcodes are rejected.

See function UpcE::SetRejectMisreadCode() for details.

Returns: true if damaged UPC-A or EAN-13 barcodes are rejected, false otherwise.

◆ SetEnableUpcE1()

UpcE & SetEnableUpcE1 ( bool value )

inline

Enables or disables UPC-E1 decoding.

Parameters

value Set to true, if UPC-E1 decoding should be enabled, false otherwise.

Returns: A reference to the current configuration object for method chaining.

◆ SetEnableUpcEExpansion()

UpcE & SetEnableUpcEExpansion ( bool value )

inline

Enables or disables the expansion of detected UPC-E codes to the UPC-A format.

Parameters

value Set to true to enable the expansion of detected UPC-E codes to the UPC-A format.

Returns: A reference to the current configuration object for method chaining.

◆ SetRejectMisreadCode()

UpcE & SetRejectMisreadCode ( bool value )

inline

Configures 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.

Parameters

value Set to true to reject damaged UPC-A or EAN-13 barcodes that could be misread as UPC-E. Set to false to allow decoding of such damaged barcodes as UPC-E.

Returns: A reference to the current configuration object for method chaining.

◆ SetStripCheckDigit()

UpcE & SetStripCheckDigit ( bool value )

inlineoverridevirtual

Enables or disables the removal of the check digit from read codes.

Parameters

value Set to true to enable check digit removal, or false to keep the check digit.

Returns: A reference to the current configuration object for method chaining.

Implements UpcEanBase< UpcE >.

◆ SetStripNumberSystemDigit()

UpcE & SetStripNumberSystemDigit ( bool value )

inline

Enables or disables the removal of the UPC-E Number System digit from read codes.

Parameters

value Set to true to enable UPC-E Number System digit removal, or false to keep the digit.

Returns: A reference to the current configuration object for method chaining.

◆ SetSupplemental()

UpcE & SetSupplemental	(	SupplementalCode	supplement,
		bool	required = false,
		bool	addSpace = true )

inlineoverridevirtual

Configures supplemental code decoding.

Parameters

supplement	Specifies the type of supplemental code to decode.
required	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	Enables or disables adding a space character between the code and the supplemental code.

Returns: A reference to the current configuration object for method chaining.

Implements UpcEanBase< UpcE >.

◆ StripCheckDigit()

bool StripCheckDigit ( ) const

inlineoverridevirtual

Determines whether check digit removal is enabled.

Returns: true if check digit removal is enabled, false otherwise.

Implements UpcEanBase< UpcE >.

◆ StripNumberSystemDigit()

bool StripNumberSystemDigit ( ) const

inline

Determines whether UPC-E Number System digit removal is enabled.

Returns: true if check UPC-E Number System digit removal is enabled, false otherwise.

◆ Supplemental()

SupplementalCode Supplemental ( ) const

inlineoverridevirtual

Retrieves the current configuration of the supplemental code decoding.

Returns: The configured supplemental code decoding mode.

Implements UpcEanBase< UpcE >.

Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ EnabledUpcE1()

◆ EnabledUpcEExpansion()

◆ RejectMisreadCode()

◆ SetEnableUpcE1()

◆ SetEnableUpcEExpansion()

◆ SetRejectMisreadCode()

◆ SetStripCheckDigit()

◆ SetStripNumberSystemDigit()

◆ SetSupplemental()

◆ StripCheckDigit()

◆ StripNumberSystemDigit()

◆ Supplemental()