clear_metrology_objectclear_metrology_objectClearMetrologyObjectclear_metrology_objectClearMetrologyObjectClearMetrologyObject (Operator)

Name

clear_metrology_objectclear_metrology_objectClearMetrologyObjectclear_metrology_objectClearMetrologyObjectClearMetrologyObject — Delete metrology objects and free the allocated memory.

Signature

Description

clear_metrology_objectclear_metrology_objectClearMetrologyObjectclear_metrology_objectClearMetrologyObjectClearMetrologyObject deletes in a metrology model metrology objects created, e.g, by add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasure, add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasure, add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasure, or add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measure (see create_metrology_modelcreate_metrology_modelCreateMetrologyModelcreate_metrology_modelCreateMetrologyModelCreateMetrologyModel for the basic principle of 2D metrology). All memory used by the metrology objects is freed. The handle of the metrology model is passed in MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle. 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.

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

Parameters

Result

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

Module

2D Metrology