copy_dictT_copy_dictCopyDictCopyDictcopy_dict (Operator)

Name

copy_dictT_copy_dictCopyDictCopyDictcopy_dict — Copy a dictionary.

Signature

copy_dict( : : DictHandle, GenParamName, GenParamValue : CopiedDictHandle)

Description

copy_dictcopy_dictCopyDictCopyDictCopyDictcopy_dict creates a deep copy (i.e., all contained handles and iconic objects are deep copied) of the dictionary DictHandleDictHandleDictHandleDictHandledictHandledict_handle in the dictionary CopiedDictHandleCopiedDictHandleCopiedDictHandleCopiedDictHandlecopiedDictHandlecopied_dict_handle.

If DictHandleDictHandleDictHandleDictHandledictHandledict_handle contains a handle that can not be copied or that has been freed already, an exception is raised per default. This behavior is controlled by GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name 'raise_error_if_content_not_serializable', and the corresponding GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value can take the following values:

'true'"true""true""true""true""true":: The default: Errors are raised and the copy process aborted.
'low_level'"low_level""low_level""low_level""low_level""low_level":: Only low level errors are raised. Instead of the handle concerned an empty handle is copied in CopiedDictHandleCopiedDictHandleCopiedDictHandleCopiedDictHandlecopiedDictHandlecopied_dict_handle and the copy process will be continued. The behavior regarding HALCON low level errors is determined by 'do_low_error'"do_low_error""do_low_error""do_low_error""do_low_error""do_low_error" in set_systemset_systemSetSystemSetSystemSetSystemset_system.
'false'"false""false""false""false""false":: The errors are suppressed. Instead of the handle concerned an empty handle is copied in CopiedDictHandleCopiedDictHandleCopiedDictHandleCopiedDictHandlecopiedDictHandlecopied_dict_handle and the copy process will be continued.

Execution Information

Multithreading type: independent (runs in parallel even with exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

DictHandleDictHandleDictHandleDictHandledictHandledict_handle (input_control) dict → (handle)

Dictionary handle.

Number of elements: DictHandle == 1

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → (string)

Name of the generic parameter.

Default value: []

List of values: 'raise_error_if_content_not_serializable'

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) attribute.name(-array) → (string / integer / real)

Value of the generic parameter.

Default value: []

Suggested values: 'true'"true""true""true""true""true", 'false'"false""false""false""false""false", 'low_level'"low_level""low_level""low_level""low_level""low_level"

CopiedDictHandleCopiedDictHandleCopiedDictHandleCopiedDictHandlecopiedDictHandlecopied_dict_handle (output_control) dict → (handle)

Copied dictionary handle.

Number of elements: CopiedDictHandle == 1

Result

If the parameters are valid, the operator copy_dictcopy_dictCopyDictCopyDictCopyDictcopy_dict returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.