clear_metrology_objectT_clear_metrology_objectClearMetrologyObjectClearMetrologyObjectclear_metrology_object (Operator)

Name

clear_metrology_objectT_clear_metrology_objectClearMetrologyObjectClearMetrologyObjectclear_metrology_object — Delete metrology objects and free the allocated memory.

Signature

clear_metrology_object( : : MetrologyHandle, Index : )

Herror T_clear_metrology_object(const Htuple MetrologyHandle, const Htuple Index)

void ClearMetrologyObject(const HTuple& MetrologyHandle, const HTuple& Index)

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

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

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

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

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

void HMetrologyModel.ClearMetrologyObject(HTuple index)

void HMetrologyModel.ClearMetrologyObject(string index)

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

Description

clear_metrology_objectclear_metrology_objectClearMetrologyObjectClearMetrologyObjectClearMetrologyObjectclear_metrology_object deletes in a metrology model metrology objects created, e.g, by add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureadd_metrology_object_circle_measure, add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measure, add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureadd_metrology_object_line_measure, or add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measure.

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

All memory used by the metrology objects is freed. The handle of the metrology model is passed in MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle. The index of the metrology objects is passed in IndexIndexIndexIndexindexindex. If IndexIndexIndexIndexindexindex is set to 'all'"all""all""all""all""all", all metrology objects are deleted. After the operator call the metrology objects are invalid.

Execution Information

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

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

Handle of the metrology model.

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

Index of the metrology objects.

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

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

Result

If the parameters are valid, the operator clear_metrology_objectclear_metrology_objectClearMetrologyObjectClearMetrologyObjectClearMetrologyObjectclear_metrology_object returns the value TRUE. If necessary, an exception is raised.

Module

2D Metrology