get_data_code_2d_paramT_get_data_code_2d_paramGetDataCode2dParamGetDataCode2dParam (Operator)

Name

get_data_code_2d_paramT_get_data_code_2d_paramGetDataCode2dParamGetDataCode2dParam — Get one or several parameters that describe the 2D data code model.

Signature

get_data_code_2d_param( : : DataCodeHandle, GenParamName : GenParamValue)

Herror T_get_data_code_2d_param(const Htuple DataCodeHandle, const Htuple GenParamName, Htuple* GenParamValue)

void GetDataCode2dParam(const HTuple& DataCodeHandle, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HDataCode2D::GetDataCode2dParam(const HTuple& GenParamName) const

HTuple HDataCode2D::GetDataCode2dParam(const HString& GenParamName) const

HTuple HDataCode2D::GetDataCode2dParam(const char* GenParamName) const

HTuple HDataCode2D::GetDataCode2dParam(const wchar_t* GenParamName) const   (Windows only)

static void HOperatorSet.GetDataCode2dParam(HTuple dataCodeHandle, HTuple genParamName, out HTuple genParamValue)

HTuple HDataCode2D.GetDataCode2dParam(HTuple genParamName)

HTuple HDataCode2D.GetDataCode2dParam(string genParamName)

Description

The operator get_data_code_2d_paramget_data_code_2d_paramGetDataCode2dParamGetDataCode2dParamGetDataCode2dParam allows to query the parameters that are used to describe the 2D data code model. The names of the desired parameters are passed in the generic parameter GenParamNameGenParamNameGenParamNameGenParamNamegenParamName, the corresponding values are returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. All these parameters can be set and changed at any time with the operator set_data_code_2d_paramset_data_code_2d_paramSetDataCode2dParamSetDataCode2dParamSetDataCode2dParam. A list with the names of all parameters that are valid for the used 2D data code type is returned by the operator query_data_code_2d_paramsquery_data_code_2d_paramsQueryDataCode2dParamsQueryDataCode2dParamsQueryDataCode2dParams.

For an explanation of the concept of the 2D data code reader see the introduction of chapter Identification / Data Code.

Note that the symbol structure of GS1 DataMatrix, GS1 QR Code, and GS1 Aztec is identical to the structure of Data Matrix ECC 200, QR Code and Aztec Code, respectively. Therefore, all symbology specific parameters applying to Data Matrix ECC 200, QR Code, or Aztec Code apply to their corresponding GS1 variant as well. In the following, the explicit enumeration of the parameters for any particular GS1 code is omitted for sake of readability. Instead, the relevant parameters names are to be inferred from the parameters for the corresponding non-GS1 code type or can be explicitly queried by query_data_code_2d_paramsquery_data_code_2d_paramsQueryDataCode2dParamsQueryDataCode2dParamsQueryDataCode2dParams with parameter 'get_model_params'"get_model_params""get_model_params""get_model_params""get_model_params".

The following parameters can be queried - ordered by different categories and data code types:

Size and shape of the symbol:

Appearance of the modules in the image:

General model behavior:

It is possible to query the values of several or all parameters with a single operator call by passing a tuple containing the names of all desired parameters to GenParamNameGenParamNameGenParamNameGenParamNamegenParamName. As a result a tuple of the same length with the corresponding values is returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue.

Execution Information

Parameters

DataCodeHandleDataCodeHandleDataCodeHandleDataCodeHandledataCodeHandle (input_control)  datacode_2d HDataCode2D, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the 2D data code model.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  attribute.name(-array) HTupleHTupleHtuple (string) (string) (HString) (char*)

Names of the generic parameters that are to be queried for the 2D data code model.

Default value: 'polarity' "polarity" "polarity" "polarity" "polarity"

List of values: 'additional_levels'"additional_levels""additional_levels""additional_levels""additional_levels", 'candidate_selection'"candidate_selection""candidate_selection""candidate_selection""candidate_selection", 'contrast_min'"contrast_min""contrast_min""contrast_min""contrast_min", 'contrast_tolerance'"contrast_tolerance""contrast_tolerance""contrast_tolerance""contrast_tolerance", 'decoding_scheme'"decoding_scheme""decoding_scheme""decoding_scheme""decoding_scheme", 'discard_undecoded_candidates'"discard_undecoded_candidates""discard_undecoded_candidates""discard_undecoded_candidates""discard_undecoded_candidates", 'finder_pattern_tolerance'"finder_pattern_tolerance""finder_pattern_tolerance""finder_pattern_tolerance""finder_pattern_tolerance", 'format'"format""format""format""format", 'mirrored'"mirrored""mirrored""mirrored""mirrored", 'model_type'"model_type""model_type""model_type""model_type", 'module_aspect_max'"module_aspect_max""module_aspect_max""module_aspect_max""module_aspect_max", 'module_aspect_min'"module_aspect_min""module_aspect_min""module_aspect_min""module_aspect_min", 'module_gap_max'"module_gap_max""module_gap_max""module_gap_max""module_gap_max", 'module_gap_min'"module_gap_min""module_gap_min""module_gap_min""module_gap_min", 'module_grid'"module_grid""module_grid""module_grid""module_grid", 'module_size_max'"module_size_max""module_size_max""module_size_max""module_size_max", 'module_size_min'"module_size_min""module_size_min""module_size_min""module_size_min", 'module_width_max'"module_width_max""module_width_max""module_width_max""module_width_max", 'module_width_min'"module_width_min""module_width_min""module_width_min""module_width_min", 'persistence'"persistence""persistence""persistence""persistence", 'polarity'"polarity""polarity""polarity""polarity", 'position_pattern_min'"position_pattern_min""position_pattern_min""position_pattern_min""position_pattern_min", 'quality_isoiec15415_aperture_size'"quality_isoiec15415_aperture_size""quality_isoiec15415_aperture_size""quality_isoiec15415_aperture_size""quality_isoiec15415_aperture_size", 'slant_max'"slant_max""slant_max""slant_max""slant_max", 'small_modules_robustness'"small_modules_robustness""small_modules_robustness""small_modules_robustness""small_modules_robustness", 'strict_model'"strict_model""strict_model""strict_model""strict_model", 'strict_quiet_zone'"strict_quiet_zone""strict_quiet_zone""strict_quiet_zone""strict_quiet_zone", 'string_encoding'"string_encoding""string_encoding""string_encoding""string_encoding", 'symbol_cols_max'"symbol_cols_max""symbol_cols_max""symbol_cols_max""symbol_cols_max", 'symbol_cols_min'"symbol_cols_min""symbol_cols_min""symbol_cols_min""symbol_cols_min", 'symbol_rows_max'"symbol_rows_max""symbol_rows_max""symbol_rows_max""symbol_rows_max", 'symbol_rows_min'"symbol_rows_min""symbol_rows_min""symbol_rows_min""symbol_rows_min", 'symbol_shape'"symbol_shape""symbol_shape""symbol_shape""symbol_shape", 'symbol_size_max'"symbol_size_max""symbol_size_max""symbol_size_max""symbol_size_max", 'symbol_size_min'"symbol_size_min""symbol_size_min""symbol_size_min""symbol_size_min", 'symbol_type'"symbol_type""symbol_type""symbol_type""symbol_type", 'timeout'"timeout""timeout""timeout""timeout", 'version_max'"version_max""version_max""version_max""version_max", 'version_min'"version_min""version_min""version_min""version_min"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control)  attribute.value(-array) HTupleHTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Values of the generic parameters.

Result

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

Possible Predecessors

query_data_code_2d_paramsquery_data_code_2d_paramsQueryDataCode2dParamsQueryDataCode2dParamsQueryDataCode2dParams, set_data_code_2d_paramset_data_code_2d_paramSetDataCode2dParamSetDataCode2dParamSetDataCode2dParam, find_data_code_2dfind_data_code_2dFindDataCode2dFindDataCode2dFindDataCode2d

Possible Successors

find_data_code_2dfind_data_code_2dFindDataCode2dFindDataCode2dFindDataCode2d, write_data_code_2d_modelwrite_data_code_2d_modelWriteDataCode2dModelWriteDataCode2dModelWriteDataCode2dModel

Alternatives

write_data_code_2d_modelwrite_data_code_2d_modelWriteDataCode2dModelWriteDataCode2dModelWriteDataCode2dModel

See also

query_data_code_2d_paramsquery_data_code_2d_paramsQueryDataCode2dParamsQueryDataCode2dParamsQueryDataCode2dParams, set_data_code_2d_paramset_data_code_2d_paramSetDataCode2dParamSetDataCode2dParamSetDataCode2dParam, get_data_code_2d_resultsget_data_code_2d_resultsGetDataCode2dResultsGetDataCode2dResultsGetDataCode2dResults, get_data_code_2d_objectsget_data_code_2d_objectsGetDataCode2dObjectsGetDataCode2dObjectsGetDataCode2dObjects, find_data_code_2dfind_data_code_2dFindDataCode2dFindDataCode2dFindDataCode2d

Module

Data Code