Configuration to access parameters of DataMatrix. More...
#include <cvb/barcode/_detail/data_matrix.hpp>
Inherits Reader2DConfigBase.
Public Member Functions | |
void | SetLevels (DataMatrixLevels levels) |
Bit field which specifies the permitted error correction level (ECCs). More... | |
void | SetFormats (DataMatrixFormats formats) |
Bit field which specifies the permitted coding schemes (also known as format IDs) (only for ECC 000 to ECC 140). More... | |
DataMatrixFormats | Formats () const |
Bit field which specifies the permitted coding schemes (also known as format IDs) (only for ECC 000 to ECC 140). More... | |
void | SetMinSize (int minSize) |
Minimum number of lines and columns. More... | |
int | MinSize () const |
Returns the minimum number of lines and columns. More... | |
void | SetMaxSize (int maxSize) |
Maximum number of lines and columns. More... | |
int | MaxSize () const |
Returns the maximum number of lines and columns. More... | |
void | SetAllowRectangular (bool rectangular) |
Permit/do not permit rectangular Data Matrix. More... | |
bool | AllowRectangular () const |
Returns whether to permit/not permit rectangular Data Matrix. More... | |
void | SetAllowDistorted (bool distorted) |
Code is distorted (no effect with dotted Data Matrix). More... | |
bool | AllowDistorted () const |
Returns whether the code is distorted (no effect with dotted Data Matrix). More... | |
void | SetSubType (DataMatrixSubType subType) |
Distinguish between evaluate characteristics of the Data Matrix code (DataMatrixSubType::DataMatrix, DataMatrixSubType::PharmaCode2D and DataMatrixSubType::DottedDatamatrix). More... | |
DataMatrixSubType | SubType () const |
Returns the evaluate characteristics of the Data Matrix code (DataMatrixSubType::DataMatrix, DataMatrixSubType::PharmaCode2D and DataMatrixSubType::DottedDatamatrix). More... | |
void | SetPharmaCode2DBar1 (PharmaCode2DDisposition pharmaCode2DBar1) |
Proofing of the color bar of field 1 on square or rectangular (2D Pharma Codes only) More... | |
PharmaCode2DDisposition | PharmaCode2DBar1 () const |
Returns the proofing of the color bar of field 1 on square or rectangular (2D Pharma Codes only) More... | |
void | SetPharmaCode2DBar2 (PharmaCode2DDisposition pharmaCode2DBar2) |
Proofing of the color bar of field 2 on square or rectangular (2D Pharma Codes only) More... | |
PharmaCode2DDisposition | PharmaCode2DBar2 () const |
Returns the proofing of the color bar of field 2 on square or rectangular (2D Pharma Codes only) More... | |
void | SetPharmaCode2DBar3 (PharmaCode2DDisposition pharmaCode2DBar3) |
Proofing of the color bar of field 3 on square or rectangular (2D Pharma Codes only) More... | |
PharmaCode2DDisposition | PharmaCode2DBar3 () const |
Returns the proofing of the color bar of field 3 on square or rectangular (2D Pharma Codes only) More... | |
void | SetPharmaCode2DBar4 (PharmaCode2DDisposition pharmaCode2DBar4) |
Proofing of the color bar of field 4 on square or rectangular (2D Pharma Codes only) More... | |
PharmaCode2DDisposition | PharmaCode2DBar4 () const |
Returns the proofing of the color bar of field 4 on square or rectangular (2D Pharma Codes only) More... | |
void | SetPharmaCode2DBar5 (PharmaCode2DDisposition pharmaCode2DBar5) |
Proofing of the color bar of field 5 on square or rectangular (2D Pharma Codes only) More... | |
PharmaCode2DDisposition | PharmaCode2DBar5 () const |
Returns the proofing of the color bar of field 5 on square or rectangular (2D Pharma Codes only) More... | |
void | SetPharmaCode2DBar6 (PharmaCode2DDisposition pharmaCode2DBar6) |
Proofing of the color bar of field 6 on square or rectangular (2D Pharma Codes only) More... | |
PharmaCode2DDisposition | PharmaCode2DBar6 () const |
Returns the proofing of the color bar of field 6 on square or rectangular (2D Pharma Codes only) More... | |
void | SetPharmaCode2DBar7 (PharmaCode2DDisposition pharmaCode2DBar7) |
Proofing of the color bar of field 7 on square or rectangular (2D Pharma Codes only) More... | |
PharmaCode2DDisposition | PharmaCode2DBar7 () const |
Returns the proofing of the color bar of field 7 on square or rectangular (2D Pharma Codes only) More... | |
void | SetPharmaCode2DBar8 (PharmaCode2DDisposition pharmaCode2DBar8) |
Proofing of the color bar of field 8 on square or rectangular (2D Pharma Codes only) More... | |
PharmaCode2DDisposition | PharmaCode2DBar8 () const |
Returns the proofing of the color bar of field 8 on square or rectangular (2D Pharma Codes only) More... | |
void | SetPharmaCode2DThreshold (int threshold) |
Minimum digitalisation threshold of the colour bars in percent (only for 2D Pharmacode) ranging from 0 to 100. More... | |
int | PharmaCode2DThreshold () const |
Returns the minimum digitalisation threshold of the colour bars in percent (only for 2D Pharmacode) ranging from 0 to 100. More... | |
void | SetPharmaCode2DExpanded (bool expanded) |
Specifies whether the code is expanded or not(only for 2D Pharmacode). More... | |
bool | PharmaCode2DExpanded () const |
Returns whether the code is expanded or not(only for 2D Pharmacode). More... | |
void | SetDottedContrast (int contrast) |
Minimal contrast value of the code (only dotted Data Matrix). More... | |
int | DottedContrast () const |
Returns the minimal contrast value of the code (only dotted Data Matrix). More... | |
void | SetDottedModuleWidth (int moduleWidth) |
The module width of the code (only dotted Data Matrix). More... | |
int | DottedModuleWidth () const |
Returns the module width of the code (only dotted Data Matrix). More... | |
void | SetDottedQuietzoneWidth (int quietzone) |
Quiet zone around the code (only dotted Data Matrix). More... | |
int | DottedQuietzoneWidth () const |
Returns the quiet zone around the code (only dotted Data Matrix). More... | |
Public Member Functions inherited from Reader2DConfigBase | |
void | SetMirrored (bool mirrored) |
Sets whether the code is mirrored/not mirrored. More... | |
bool | Mirrored () const |
Returns whether the code is mirrored/not mirrored. More... | |
Public Member Functions inherited from ReaderConfigBase | |
void | SetInverse (bool inverse) |
Code is inverted (white on black)/not inverted. More... | |
bool | Inverse () const |
Returns whether the code is inverted (white on black) or not. More... | |
Static Public Member Functions | |
static std::unique_ptr< DataMatrix > | FromHandle (const HandleGuard< ReaderConfig > &guard, bool &isActiveOut) |
Create object from handle. More... | |
Configuration to access parameters of DataMatrix.
|
inline |
Returns whether the code is distorted (no effect with dotted Data Matrix).
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns whether to permit/not permit rectangular Data Matrix.
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the minimal contrast value of the code (only dotted Data Matrix).
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the module width of the code (only dotted Data Matrix).
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the quiet zone around the code (only dotted Data Matrix).
Any | exception derived from std::exception including CvbException. |
|
inline |
Bit field which specifies the permitted coding schemes (also known as format IDs) (only for ECC 000 to ECC 140).
Any | exception derived from std::exception including CvbException. |
|
inlinestatic |
Create object from handle.
[in] | guard | Handle guard to read the configuration from. |
[out] | isActiveOut | Returns the active state of the configuration in the handle. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the maximum number of lines and columns.
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the minimum number of lines and columns.
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the proofing of the color bar of field 1 on square or rectangular (2D Pharma Codes only)
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the proofing of the color bar of field 2 on square or rectangular (2D Pharma Codes only)
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the proofing of the color bar of field 3 on square or rectangular (2D Pharma Codes only)
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the proofing of the color bar of field 4 on square or rectangular (2D Pharma Codes only)
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the proofing of the color bar of field 5 on square or rectangular (2D Pharma Codes only)
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the proofing of the color bar of field 6 on square or rectangular (2D Pharma Codes only)
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the proofing of the color bar of field 7 on square or rectangular (2D Pharma Codes only)
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the proofing of the color bar of field 8 on square or rectangular (2D Pharma Codes only)
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns whether the code is expanded or not(only for 2D Pharmacode).
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the minimum digitalisation threshold of the colour bars in percent (only for 2D Pharmacode) ranging from 0 to 100.
Any | exception derived from std::exception including CvbException. |
|
inline |
Code is distorted (no effect with dotted Data Matrix).
When set to true, the reader will also read distorted data matrix codes. This flag will not have any effect when reading dotted data matrix codes.
[in] | distorted | When set to true, the reader will also read distorted data matrix codes. This flag will not have any effect when reading dotted data matrix codes. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Permit/do not permit rectangular Data Matrix.
[in] | rectangular | If this parameter is true, it specifies that rectangular codes are permitted for evaluation. Attention: Rectangular codes are defined for ECC 200 only. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Minimal contrast value of the code (only dotted Data Matrix).
[in] | contrast | The parameter contrast is a scale for the minimal contrast that must be to find and read the dotted Data Matrix code in the picture. How inferior the contrast is, the lower the minimum contrast has to be set to read the code. Normally the value is in the range of 30 to 40 default is 30). Valid values are in the interval [10...100] |
Any | exception derived from std::exception including CvbException. |
|
inline |
The module width of the code (only dotted Data Matrix).
[in] | moduleWidth | The module width is the count of pixel*10 of the moduleWidth of one module, it can be calculated with: moduleWidth = whole code width in pixel (without quiet zone) / number of modules*10 (default 50). Valid values are in the interval [30...150] |
Any | exception derived from std::exception including CvbException. |
|
inline |
Quiet zone around the code (only dotted Data Matrix).
[in] | quietzone | This is the quiet zone around the code in DottedModuleWidth(), normally it is set to 5 module widths. Only if it is absolute necessary it can set down finally to 3 to read a code with a very short quiet zone (default 5). Valid values are in the interval [3...5]. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Bit field which specifies the permitted coding schemes (also known as format IDs) (only for ECC 000 to ECC 140).
[in] | formats | You use the formats parameter to restrict the evaluation of a Data Matrix of types ECC 0 to ECC 140 to certain coding schemes (also known as encoding schemes or format IDS). To this end, the constants DataMatrixFormats::Base11, DataMatrixFormats::Base27, DataMatrixFormats::Base37, DataMatrixFormats::Base41, DataMatrixFormats::Ascii and DataMatrixFormats::Binary are defined. These constants can be combined in any way using a bitwise OR operator. If you want to permit all formats, you can specify the constant DataMatrixFormats::All. In the case of an ECC 200 Data Matrix, this parameter is not used. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Bit field which specifies the permitted error correction level (ECCs).
[in] | levels | Bit field which specifies the permitted error correction level (ECCs). |
Any | exception derived from std::exception including CvbException. |
|
inline |
Maximum number of lines and columns.
[in] | maxSize | You can use the MinSize() and maxSize parameters to restrict Data Matrix evaluation to certain sizes. The sizes then refer to the number of modules or cells; peripheral structures are counted but quiet zones are not. Valid values are in the interval [7...144]. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Minimum number of lines and columns.
[in] | minSize | You can use the minSize and MaxSize() parameters to restrict Data Matrix evaluation to certain sizes. The sizes then refer to the number of modules or cells; peripheral structures are counted but quiet zones are not. Valid values are in the interval [7...144]. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Proofing of the color bar of field 1 on square or rectangular (2D Pharma Codes only)
[in] | pharmaCode2DBar1 | Adjusts the proofing of the colour bar of field 1 using a quadratic or rectangular 2D Pharmacode. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Proofing of the color bar of field 2 on square or rectangular (2D Pharma Codes only)
[in] | pharmaCode2DBar2 | Adjusts the proofing of the colour bar of field 2 using a quadratic or rectangular 2D Pharmacode. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Proofing of the color bar of field 3 on square or rectangular (2D Pharma Codes only)
[in] | pharmaCode2DBar3 | Adjusts the proofing of the colour bar of field 3 using a quadratic or rectangular 2D Pharmacode. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Proofing of the color bar of field 4 on square or rectangular (2D Pharma Codes only)
[in] | pharmaCode2DBar4 | Adjusts the proofing of the colour bar of field 4 using a quadratic or rectangular 2D Pharmacode. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Proofing of the color bar of field 5 on square or rectangular (2D Pharma Codes only)
[in] | pharmaCode2DBar5 | Adjusts the proofing of the colour bar of field 5 using a quadratic or rectangular 2D Pharmacode. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Proofing of the color bar of field 6 on square or rectangular (2D Pharma Codes only)
[in] | pharmaCode2DBar6 | Adjusts the proofing of the colour bar of field 6 using a quadratic or rectangular 2D Pharmacode. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Proofing of the color bar of field 7 on square or rectangular (2D Pharma Codes only)
[in] | pharmaCode2DBar7 | Adjusts the proofing of the colour bar of field 7 using a quadratic or rectangular 2D Pharmacode. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Proofing of the color bar of field 8 on square or rectangular (2D Pharma Codes only)
[in] | pharmaCode2DBar8 | Adjusts the proofing of the colour bar of field 8 using a quadratic or rectangular 2D Pharmacode. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Specifies whether the code is expanded or not(only for 2D Pharmacode).
[in] | expanded | The parameter expanded permits a larger tolerance of the colour bars of the 2D Pharmacode (default: false). |
Any | exception derived from std::exception including CvbException. |
|
inline |
Minimum digitalisation threshold of the colour bars in percent (only for 2D Pharmacode) ranging from 0 to 100.
[in] | threshold | Minimum digitalisation threshold of the colour bars in percent (only for 2D Pharmacode) ranging from 0 to 100. The default value is 35. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Distinguish between evaluate characteristics of the Data Matrix code (DataMatrixSubType::DataMatrix, DataMatrixSubType::PharmaCode2D and DataMatrixSubType::DottedDatamatrix).
[in] | subType | Distinguish between evaluate characteristics of the Data Matrix code (DataMatrix, PharmaCode2D and DottedDatamatrix). |
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the evaluate characteristics of the Data Matrix code (DataMatrixSubType::DataMatrix, DataMatrixSubType::PharmaCode2D and DataMatrixSubType::DottedDatamatrix).
Any | exception derived from std::exception including CvbException. |