Skip to content

clear_metrology_modelClearMetrologyModelClearMetrologyModelclear_metrology_modelT_clear_metrology_model🔗

Short description🔗

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

Signature🔗

clear_metrology_model( metrology_model MetrologyHandle )void ClearMetrologyModel( const HTuple& MetrologyHandle )static void HOperatorSet.ClearMetrologyModel( HTuple metrologyHandle )def clear_metrology_model( metrology_handle: HHandle ) -> None

Herror T_clear_metrology_model( const Htuple MetrologyHandle )

void HMetrologyModel::ClearMetrologyModel( ) const

void HMetrologyModel.ClearMetrologyModel( )

Description🔗

clear_metrology_modelClearMetrologyModel deletes a metrology model that was created by create_metrology_modelCreateMetrologyModel, copy_metrology_modelCopyMetrologyModel, read_metrology_modelReadMetrologyModel, or deserialize_metrology_modelDeserializeMetrologyModel. 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 MetrologyHandlemetrologyHandlemetrology_handle. 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🔗

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:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters🔗

MetrologyHandlemetrologyHandlemetrology_handle (input_control, state is modified) metrology_model → (handle)HTuple (HHandle)HMetrologyModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the metrology model.

Result🔗

The operator clear_metrology_modelClearMetrologyModel 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.

Combinations with other operators🔗

Combinations

Possible predecessors

get_metrology_object_resultGetMetrologyObjectResult, write_metrology_modelWriteMetrologyModel

Module🔗

2D Metrology