write_dictT_write_dictWriteDictWriteDict (Operator)

Name

write_dictT_write_dictWriteDictWriteDict — Write a dictionary to a file.

Signature

write_dict( : : DictHandle, FileName, GenParamName, GenParamValue : )

Description

write_dictwrite_dictWriteDictWriteDictWriteDict writes the dictionary denoted by the DictHandleDictHandleDictHandleDictHandledictHandle to the file FileNameFileNameFileNameFileNamefileName. The file is written as 'hdict', the HALCON format for dictionaries. The default HALCON file extension for a dictionary is 'hdict'.

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

'true'"true""true""true""true":: The default behavior, errors are raised.
'false'"false""false""false""false":: The errors are suppressed, empty handles are written in place of the non serializable handles.
'low_level'"low_level""low_level""low_level""low_level":: Only low level errors are raised containing the handles in question. Empty handles are written in place of the non serializable handles. 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" in set_systemset_systemSetSystemSetSystemSetSystem.

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

DictHandleDictHandleDictHandleDictHandledictHandle (input_control) dict → (handle)

Dictionary handle.

Number of elements: DictHandle == 1

FileNameFileNameFileNameFileNamefileName (input_control) filename.write → (string)

File name.

File extension: .hdict

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

Name of the generic parameter.

Default value: []

List of values: 'raise_error_if_content_not_serializable'

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

Value of the generic parameter.

Default value: []

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

Result

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