clear_metrology_modelT_clear_metrology_modelClearMetrologyModelClearMetrologyModel (Operator)

Name

clear_metrology_modelT_clear_metrology_modelClearMetrologyModelClearMetrologyModel — Delete a metrology model and free the allocated memory.

Signature

clear_metrology_model( : : MetrologyHandle : )

Description

clear_metrology_modelclear_metrology_modelClearMetrologyModelClearMetrologyModelClearMetrologyModel deletes a metrology model that was created by create_metrology_modelcreate_metrology_modelCreateMetrologyModelCreateMetrologyModelCreateMetrologyModel, copy_metrology_modelcopy_metrology_modelCopyMetrologyModelCopyMetrologyModelCopyMetrologyModel, read_metrology_modelread_metrology_modelReadMetrologyModelReadMetrologyModelReadMetrologyModel, or deserialize_metrology_modeldeserialize_metrology_modelDeserializeMetrologyModelDeserializeMetrologyModelDeserializeMetrologyModel. Note that by deleting the model also the including metrology objects are deleted. All memory used by the metrology model and the metrology objects is freed. The handle of the model is passed in MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle. After the operator call, the metrology model is invalid.

For an explanation of the concept of 2D metrology see the introduction of chapter 2D Metrology.

Execution Information

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

This operator modifies the state of the following input parameter:

MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle (input_control, state is modified) metrology_model → (handle)

Handle of the metrology model.

The operator clear_metrology_modelclear_metrology_modelClearMetrologyModelClearMetrologyModelClearMetrologyModel returns the value 2 (H_MSG_TRUE) if a valid handle was passed and the referred metrology model can be freed correctly. Otherwise, an exception will be raised.

Possible Predecessors

get_metrology_object_resultget_metrology_object_resultGetMetrologyObjectResultGetMetrologyObjectResultGetMetrologyObjectResult, write_metrology_modelwrite_metrology_modelWriteMetrologyModelWriteMetrologyModelWriteMetrologyModel

Module

2D Metrology

Operators