UpcA Class Reference

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

#include <cvb/config.hpp>

Inherits UpcEanBase< UpcA >.

Public Member Functions
UpcA &	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.
UpcA &	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.
UpcA &	SetStripNumberSystemDigit (bool value)
	Enables or disables the removal of the UPC-A Number System digit from read codes.
bool	StripNumberSystemDigit () const
	Determines whether UPC-A Number System digit removal is enabled.
UpcA &	SetConvertToEAN13 (bool value)
	Enables or disables the conversion of 12-digit UPC-A codes to 13-digit EAN-13 format in the decoded data.
bool	ConvertedToEAN13 () const
	Determines whether the conversion of 12-digit UPC-A codes to 13-digit EAN-13 format is enabled or disabled.
Public Member Functions inherited from UpcEanBase< UpcA >
virtual UpcA &	EnableCCA () override
	Enables Composite Component A (CC-A) decoding.
virtual UpcA &	DisableCCA () override
	Disables Composite Component A (CC-A) decoding.
virtual UpcA &	EnableCCB () override
	Enables Composite Component B (CC-B) decoding.
virtual UpcA &	DisableCCB () override
	Disables Composite Component B (CC-B) decoding.
virtual UpcA &	EnableCCC () override
	Enables Composite Component C (CC-C) decoding.
virtual UpcA &	DisableCCC () override
	Disables Composite Component C (CC-C) decoding.
Public Member Functions inherited from CompositeCodeBase< UpcA >
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< UpcA >
bool	Enabled () const
	Checks if decoding for the code type represented by the derived class is enabled.
UpcA &	Enable ()
	Enables decoding for the code type represented by the derived class.
UpcA &	Disable ()
	Disables decoding for the code type represented by the derived class.

Friends
class	Cvb::CodeReader::Decoder

Detailed Description

Configuration class for UPC-A barcodes.

Use this class to configure decoding options for UPC-A barcodes. To access the configuration and enable decoding UPC-A 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::UpcA>().Enable();

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

ConvertedToEAN13()

bool ConvertedToEAN13 ( ) const

inline

Determines whether the conversion of 12-digit UPC-A codes to 13-digit EAN-13 format is enabled or disabled.

Returns

true if the conversion of 12-digit UPC-A codes to 13-digit EAN-13 format in the decoded data is enabled, false otherwise.

SetConvertToEAN13()

UpcA & SetConvertToEAN13 ( bool value )

inline

Enables or disables the conversion of 12-digit UPC-A codes to 13-digit EAN-13 format in the decoded data.

Note, enabling this option will also activate the detection of EAN-13 codes.

Parameters

value

Set to true to enable the conversion, or false to disable it.

Returns

A reference to the current configuration object for method chaining.

SetStripCheckDigit()

UpcA & 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< UpcA >.

SetStripNumberSystemDigit()

UpcA & SetStripNumberSystemDigit ( bool value )

inline

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

Parameters

value

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

Returns

A reference to the current configuration object for method chaining.

SetSupplemental()

UpcA & 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< UpcA >.

StripCheckDigit()

bool StripCheckDigit ( ) const

inlineoverridevirtual

Determines whether check digit removal is enabled.

Returns

true if check digit removal is enabled, false otherwise.

Implements UpcEanBase< UpcA >.

StripNumberSystemDigit()

bool StripNumberSystemDigit ( ) const

inline

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

Returns

true if check UPC-A 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< UpcA >.