clear_metrology_object — Delete metrology objects and free the allocated memory.
clear_metrology_object( : : MetrologyHandle, Index : )
clear_metrology_object deletes in a metrology
model metrology objects created, e.g, by
add_metrology_object_circle_measure,
add_metrology_object_ellipse_measure,
add_metrology_object_line_measure, or
add_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 MetrologyHandle. The index of the metrology
objects is passed in Index. If Index is set
to 'all', all metrology objects are deleted. After the
operator call the metrology objects are invalid.
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.
MetrologyHandle (input_control, state is modified) metrology_model → (handle)
Handle of the metrology model.
Index (input_control) integer(-array) → (string / integer)
Index of the metrology objects.
Default value: 'all'
Suggested values: 'all', 0, 1, 2
If the parameters are valid, the operator clear_metrology_object
returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
2D Metrology