CVB++ 15.0
Loading...
Searching...
No Matches
Ean13 Class Referencefinal

Configuration class for EAN-13 barcodes. More...

#include <cvb/config.hpp>

Inherits UpcEanBase< Ean13 >.

Public Member Functions

Ean13SetSupplemental (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.
 
Ean13SetStripCheckDigit (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.
 
Ean13SetConvertBooklandToISBN (bool value)
 Enables or disables conversion from Bookland to ISBN.
 
bool ConvertedFromBooklandToISBN () const
 Determines whether conversion from Bookland to ISBN is enabled or disabled.
 
Ean13SetConvertBooklandToISSN (bool value)
 Enables or disables conversion from Bookland to ISSN.
 
bool ConvertedFromBooklandToISSN () const
 Determines whether conversion from Bookland to ISSN is enabled or disabled.
 
- Public Member Functions inherited from UpcEanBase< Ean13 >
virtual Ean13EnableCCA () override
 Enables Composite Component A (CC-A) decoding.
 
virtual Ean13DisableCCA () override
 Disables Composite Component A (CC-A) decoding.
 
virtual Ean13EnableCCB () override
 Enables Composite Component B (CC-B) decoding.
 
virtual Ean13DisableCCB () override
 Disables Composite Component B (CC-B) decoding.
 
virtual Ean13EnableCCC () override
 Enables Composite Component C (CC-C) decoding.
 
virtual Ean13DisableCCC () override
 Disables Composite Component C (CC-C) decoding.
 
- Public Member Functions inherited from CompositeCodeBase< Ean13 >
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< Ean13 >
bool Enabled () const
 Checks if decoding for the code type represented by the derived class is enabled.
 
Ean13Enable ()
 Enables decoding for the code type represented by the derived class.
 
Ean13Disable ()
 Disables decoding for the code type represented by the derived class.
 

Friends

class Cvb::CodeReader::Decoder
 

Detailed Description

Configuration class for EAN-13 barcodes.

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

static std::unique_ptr< Decoder > Create()
Creates and returns a new Decoder instance.
Definition detail_decoder.hpp:22
@ Enable
Enable checksum.
Definition decl_config_logistic_codes.hpp:19
@ Ean13
EAN-13.
Definition decl_config_base.hpp:57
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

◆ ConvertedFromBooklandToISBN()

bool ConvertedFromBooklandToISBN ( ) const
inline

Determines whether conversion from Bookland to ISBN is enabled or disabled.

Returns
true, if conversion from Bookland to ISBN is enabled, false otherwise.

◆ ConvertedFromBooklandToISSN()

bool ConvertedFromBooklandToISSN ( ) const
inline

Determines whether conversion from Bookland to ISSN is enabled or disabled.

Returns
true, if conversion from Bookland to ISSN is enabled, false otherwise.

◆ SetConvertBooklandToISBN()

Ean13 & SetConvertBooklandToISBN ( bool value)
inline

Enables or disables conversion from Bookland to ISBN.

Parameters
valueSet to true to enable the conversion, or false to disable it.
Returns
A reference to the current configuration object for method chaining.

◆ SetConvertBooklandToISSN()

Ean13 & SetConvertBooklandToISSN ( bool value)
inline

Enables or disables conversion from Bookland to ISSN.

Parameters
valueSet to true to enable the conversion, or false to disable it.
Returns
A reference to the current configuration object for method chaining.

◆ SetStripCheckDigit()

Ean13 & SetStripCheckDigit ( bool value)
inlineoverridevirtual

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

Parameters
valueSet 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< Ean13 >.

◆ SetSupplemental()

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

Configures supplemental code decoding.

Parameters
supplementSpecifies the type of supplemental code to decode.
requiredIf 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.
addSpaceEnables 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< Ean13 >.

◆ StripCheckDigit()

bool StripCheckDigit ( ) const
inlineoverridevirtual

Determines whether check digit removal is enabled.

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

Implements UpcEanBase< Ean13 >.

◆ Supplemental()

SupplementalCode Supplemental ( ) const
inlineoverridevirtual

Retrieves the current configuration of the supplemental code decoding.

Returns
The configured supplemental code decoding mode.

Implements UpcEanBase< Ean13 >.