Skip to content

reset_metrology_object_paramResetMetrologyObjectParamResetMetrologyObjectParamreset_metrology_object_paramT_reset_metrology_object_param🔗

Short description🔗

reset_metrology_object_paramResetMetrologyObjectParamResetMetrologyObjectParamreset_metrology_object_paramT_reset_metrology_object_param — Reset all parameters of a metrology model.

Signature🔗

reset_metrology_object_param( metrology_model MetrologyHandle, integer Index )void ResetMetrologyObjectParam( const HTuple& MetrologyHandle, const HTuple& Index )static void HOperatorSet.ResetMetrologyObjectParam( HTuple metrologyHandle, HTuple index )def reset_metrology_object_param( metrology_handle: HHandle, index: MaybeSequence[Union[str, int]] ) -> None

Herror T_reset_metrology_object_param( const Htuple MetrologyHandle, const Htuple Index )

void HMetrologyModel::ResetMetrologyObjectParam( const HTuple& Index ) const

void HMetrologyModel::ResetMetrologyObjectParam( const HString& Index ) const

void HMetrologyModel::ResetMetrologyObjectParam( const char* Index ) const

void HMetrologyModel::ResetMetrologyObjectParam( const wchar_t* Index ) const (Windows only)

void HMetrologyModel.ResetMetrologyObjectParam( HTuple index )

void HMetrologyModel.ResetMetrologyObjectParam( string index )

Description🔗

reset_metrology_object_paramResetMetrologyObjectParam discards all settings of the parameters for the metrology objects that can be set by the operator set_metrology_object_paramSetMetrologyObjectParam 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 MetrologyHandlemetrologyHandlemetrology_handle. The parameter Indexindexindex determines the metrology objects to reset. With Indexindexindex set to 'all'"all", all metrology objects are reset.

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.

Indexindexindex (input_control) integer(-array) → (string / integer)HTuple (HString / Hlong)HTuple (string / int / long)MaybeSequence[Union[str, int]]Htuple (char* / Hlong)

Index of the metrology objects.

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

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

set_metrology_object_paramSetMetrologyObjectParam

See also

reset_metrology_object_fuzzy_paramResetMetrologyObjectFuzzyParam

Module🔗

2D Metrology