Cvb::CodeReader::Config Namespace Reference

This namespace contains the configuration classes for all supported codes. More...

Classes
class	AustraliaPost
	Configuration class for Australia Post. More...
class	Code11
	Configuration class for Code 11 barcodes. More...
class	Code128
	Configuration class for Code 128 barcodes. More...
class	Code32
	Configuration class for Code 32 barcodes (Italian Pharmacode). More...
class	Code39
	Configuration class for Code 39 barcodes. More...
class	Code93
	Configuration class for Code 93 barcodes. More...
class	CompositeCodeBase
	Base configuration class for composite codes. More...
class	ConfigBase
	Base configuration class. More...
class	DataMatrix
	Configuration class for Data Matrix codes. More...
class	DutchPost
	Configuration class for Dutch Post (KIX Code). More...
class	Ean13
	Configuration class for EAN-13 barcodes. More...
class	Ean8
	Configuration class for EAN-8 barcodes. More...
class	GS1DataBar14
	Configuration class for GS1 Databar-14 (omnidirectional/truncated). More...
class	GS1DataBarExpanded
	Configuration class for GS1 DataBar Expanded. More...
class	GS1DataBarExpandedStacked
	Configuration class for GS1 DataBar Expanded Stacked. More...
class	GS1DataBarLimited
	Configuration class for GS1 DataBar Limited. More...
class	GS1DataBarStacked
	Configuration class for GS1 DataBar Stacked. More...
class	Interleaved2of5
	Configuration class for Interleaved 2 of 5 barcodes. More...
class	MicroPdf417
	Configuration class for MicroPDF417 codes. More...
class	MicroQR
	Configuration class for Micro QR codes. More...
class	Pdf417
	Configuration class for PDF417 codes. More...
class	Pharmacode
	Configuration class for Pharmacodes. More...
class	QR
	Configuration class for QR codes. More...
class	RoyalMail
	Configuration class for RoyalMail 4-State codes. More...
class	UpcA
	Configuration class for UPC-A barcodes. More...
class	UpcE
	Configuration class for UPC-E barcodes. More...
class	UpcEanBase
	Base configuration class for UPC-A, UPC-E, EAN-8, and EAN-13 barcodes. More...
class	UspsIntelligentMail
	Configuration class for USPS Intelligent Mail. More...

Enumerations
enum class	Polarity { DarkOnLight = 1 , LightOnDark = -1 , Either = 0 }
	Enumeration of code polarity options for 2D codes. More...
enum class	RectangularDecoding { None = 0 , Simple = 1 , Extended = 2 }
	Enumeration for rectangular decoding modes for DataMatrix codes. More...
enum class	Checksum { None = 0 , Enable = 1 , EnableAndStrip = 2 }
	Enum class for configuring checksums. More...
enum class	Code128EnhancementMethod { None = 0 , Method1 = 1 , Method2 = 2 , All = 3 }
	Enum class for configuring enhancement method for Code128 codes. More...
enum class	Code11ChecksumDigits { None , OneDigit , TwoDigits }
	Enum class for configuring checksums for Code11 codes. More...
enum class	SupplementalCode { None , Supplement2digits , Supplement5digits , SupplementAll }
	Enum class for configuring supplemental code decoding for UpcA, UpcE, Ean8 and Ean13 codes. More...

Detailed Description

This namespace contains the configuration classes for all supported codes.

After creating a decoder, the configuration object can be accessed through the Decoder::Config() member function. The configuration class must be specified using the CodeReader::Symbology template, as shown in the following example:

auto decoder = Cvb::CodeReader::Decoder::Create();
decoder->Config<Cvb::CodeReader::Symbology::DataMatrix>().Enable().SetPolarity(Cvb::CodeReader::Config::Polarity::DarkOnLight);
decoder->Config<Cvb::CodeReader::Symbology::QR>().Enable();

Note

A detailed description of the decoding and a code example can be found here.

Enumeration Type Documentation

Checksum

enum class Checksum

strong

Enum class for configuring checksums.

Enumerator
None	Disable checksum.
Enable	Enable checksum.
EnableAndStrip	Enable checksum and remove the check character from the result.

Code11ChecksumDigits

enum class Code11ChecksumDigits

strong

Enum class for configuring checksums for Code11 codes.

Enumerator
None	Disable checksum checking.
OneDigit	Enable 1-digit checksum checking.
TwoDigits	Enable 2-digit checksum checking.

Code128EnhancementMethod

enum class Code128EnhancementMethod

strong

Enum class for configuring enhancement method for Code128 codes.

See function Code128::SetEnhancementMethod() for details.

Enumerator
None	Disable enhancement.
Method1	Enable enhancement method 1.
Method2	Enable enhancement method 2.
All	Enable both, enhancement method 1 and 2.

Polarity

enum class Polarity

strong

Enumeration of code polarity options for 2D codes.

Enumerator
DarkOnLight	The code is dark on light background.
LightOnDark	The code is light on dark background.
Either	The code can be either dark on light or light on dark.

RectangularDecoding

enum class RectangularDecoding

strong

Enumeration for rectangular decoding modes for DataMatrix codes.

Enumerator
None	Disables rectangular decoding.
Simple	Enables basic rectangular decoding.
Extended	Enables extended rectangular decoding.

SupplementalCode

enum class SupplementalCode

strong

Enum class for configuring supplemental code decoding for UpcA, UpcE, Ean8 and Ean13 codes.

Enumerator
None	Disables decoding of supplemental codes.
Supplement2digits	Enables decoding of 2-digit supplemental codes.
Supplement5digits	Enables decoding of 5-digit supplemental codes.
SupplementAll	Enables decoding of both 2-digit and 5-digit supplemental codes.