reset_metrology_object_paramreset_metrology_object_paramResetMetrologyObjectParamreset_metrology_object_paramResetMetrologyObjectParamResetMetrologyObjectParam (Operator)

Name

Signature

reset_metrology_object_param( : : MetrologyHandle, Index : )

Description

reset_metrology_object_paramreset_metrology_object_paramResetMetrologyObjectParamreset_metrology_object_paramResetMetrologyObjectParamResetMetrologyObjectParam discards all settings of the parameters for the metrology objects that can be set by the operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParam and restores the default values (see create_metrology_modelcreate_metrology_modelCreateMetrologyModelcreate_metrology_modelCreateMetrologyModelCreateMetrologyModel for the basic principle of 2D metrology).

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

Parallelization

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:

MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle

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

Parameters

MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle (input_control, state is modified) metrology_model → (integer)

Handle of the metrology model.

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

Index of the metrology objects.

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

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

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

Possible Predecessors

set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParam

Module

2D Metrology

Operators