reset_metrology_object_paramT_reset_metrology_object_paramResetMetrologyObjectParamResetMetrologyObjectParam (Operator)

Name

reset_metrology_object_paramT_reset_metrology_object_paramResetMetrologyObjectParamResetMetrologyObjectParam — Reset all parameters of a metrology model.

Signature

reset_metrology_object_param( : : MetrologyHandle, Index : )

reset_metrology_object_paramreset_metrology_object_paramResetMetrologyObjectParamResetMetrologyObjectParamResetMetrologyObjectParam discards all settings of the parameters for the metrology objects that can be set by the operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParam and restores the default values.

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

The metrology model is defined by the handle MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle. The parameter IndexIndexIndexIndexindex determines the metrology objects to reset. With IndexIndexIndexIndexindex set to 'all'"all""all""all""all", all metrology objects are reset.

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.

IndexIndexIndexIndexindex (input_control) integer(-array) → (string / integer)

Index of the metrology objects.

Default value: 'all' "all" "all" "all" "all"

Suggested values: 'all'"all""all""all""all", 0, 1, 2

Result

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

Possible Predecessors

set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParam

Module

2D Metrology

Operators