Operator Reference

reset_metrology_object_paramT_reset_metrology_object_paramResetMetrologyObjectParamResetMetrologyObjectParamreset_metrology_object_param (Operator)

reset_metrology_object_paramT_reset_metrology_object_paramResetMetrologyObjectParamResetMetrologyObjectParamreset_metrology_object_param — Reset all parameters of a metrology model.

Signature

reset_metrology_object_param( : : MetrologyHandle, Index : )

Herror T_reset_metrology_object_param(const Htuple MetrologyHandle, const Htuple Index)

void ResetMetrologyObjectParam(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)

static void HOperatorSet.ResetMetrologyObjectParam(HTuple metrologyHandle, HTuple index)

void HMetrologyModel.ResetMetrologyObjectParam(HTuple index)

void HMetrologyModel.ResetMetrologyObjectParam(string index)

def reset_metrology_object_param(metrology_handle: HHandle, index: MaybeSequence[Union[str, int]]) -> None

Description

reset_metrology_object_paramreset_metrology_object_paramResetMetrologyObjectParamResetMetrologyObjectParamreset_metrology_object_param discards all settings of the parameters for the metrology objects that can be set by the operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param 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 MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle. 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:

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

Parameters

MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle (input_control, state is modified)  metrology_model HMetrologyModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the metrology model.

IndexIndexIndexindexindex (input_control)  integer(-array) HTupleMaybeSequence[Union[str, int]]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)

Index of the metrology objects.

Default: '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_paramResetMetrologyObjectParamResetMetrologyObjectParamreset_metrology_object_param returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised.

Possible Predecessors

set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param

See also

reset_metrology_object_fuzzy_paramreset_metrology_object_fuzzy_paramResetMetrologyObjectFuzzyParamResetMetrologyObjectFuzzyParamreset_metrology_object_fuzzy_param

Module

2D Metrology