gen_2d_bar_code_descrT_gen_2d_bar_code_descrGen2dBarCodeDescrgen_2d_bar_code_descrGen2dBarCodeDescrGen2dBarCodeDescr (Operator)

Name

gen_2d_bar_code_descrT_gen_2d_bar_code_descrGen2dBarCodeDescrgen_2d_bar_code_descrGen2dBarCodeDescrGen2dBarCodeDescr — Generate a generic description of a 2D bar code class.

Warning

gen_2d_bar_code_descrgen_2d_bar_code_descrGen2dBarCodeDescrgen_2d_bar_code_descrGen2dBarCodeDescrGen2dBarCodeDescr is obsolete and is only provided for reasons of backward compatibility. New applications should use the functionality in the chapter Identification / Data Code for reading 2D data code symbologies instead (see create_data_code_2d_modelcreate_data_code_2d_modelCreateDataCode2dModelcreate_data_code_2d_modelCreateDataCode2dModelCreateDataCode2dModel).

Signature

Description

gen_2d_bar_code_descrgen_2d_bar_code_descrGen2dBarCodeDescrgen_2d_bar_code_descrGen2dBarCodeDescrGen2dBarCodeDescr creates a generic description of a 2D bar code. This description consists of the type of the bar code and further characteristic features of the code.

The parameter CodeTypeCodeTypeCodeTypeCodeTypeCodeTypecodeType specifies the type of the 2D bar code. Currently, the following types are supported:

'Data Matrix ECC 200'

Data Matrix type ECC 200.

The bar code can be described more closely using the parameters GenParamNamesGenParamNamesGenParamNamesGenParamNamesGenParamNamesgenParamNames and GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues, which form pairs of descriptors and values. The following parameters describe the size and the form of the symbols:

'columns'

Exact number of columns of the symbol.

GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues: 10, 12, 14, 16, 18, 20, 22, 24, 26, 32, 36, 40, 44, 48, 52, 64, 72, 80, 88, 96, 104, 120, 132, 144

default: -

'columns_min'

Minimum number of columns.

GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues: 10...144 (even)

default: 10

'columns_max'

Maximum number of columns.

GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues: 10...144 (even)

'rows'

Exact number of rows of the symbol.

GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues: 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 32, 36, 40, 44, 48, 52, 64, 72, 80, 88, 96, 104, 120, 132, 144

default: -

'rows_min'

Minimum number of rows.

GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues: 8...144 (even)

default: 8

'rows_max'

Maximum number of rows.

GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues: 8...144 (even)

default: 144

'shape'

Form of the symbol.

GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues: 'square', 'rectangle', 'any'

default: 'any'

The following parameters describe the printing method and the appearance of the bar code:

'foreground'

Appearance of bits corresponding to a logical 1 (foreground). 2D bar codes can be printed dark on light or vice versa. If the appearance of bits corresponding to a logical 1 can be specified in advance, computing time will be significantly reduced, especially when looking for regions that might contain a bar code (operator find_2d_bar_codefind_2d_bar_codeFind2dBarCodefind_2d_bar_codeFind2dBarCodeFind2dBarCode). GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues: 'any': unknown appearance

'dark','black': symbols are printed dark on light

'light','white': symbols are printed light on dark

default: 'any'

'mode'

Method used for printing the 2D bar code. By specifying this parameter, image processing can be optimized. GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues: 'printed': Standard black-and-white printing. Modules appear as square regions; neighboring modules with the same value form one region.

'engraved_darkfield': Modules with the value 1 are engraved into the surface, e.g. by a laser. Using dark field lighting these modules appear as dark round dots with a white corona; neighboring modules with the value 1 are therefore separated by gaps.

'engraved_lightfield': Similar to 'engraved_darkfield', but using light field lighting. Modules with the value 1 therefore appear as light dots with a dark corona; neighboring modules with the value 1 are again separated by gaps.

default: 'printed'

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Example (HDevelop)

gen_2d_bar_code_descr ('Data Matrix ECC 200', ['mode','foreground'], \
                       ['printed','dark'], BarCodeDescr)

Result

The operator gen_2d_bar_code_descrgen_2d_bar_code_descrGen2dBarCodeDescrgen_2d_bar_code_descrGen2dBarCodeDescrGen2dBarCodeDescr returns the value 2 (H_MSG_TRUE) if the given parameters are correct. Otherwise, an exception will be raised.

Module

Data Code