Skip to content

clear_metrology_objectClearMetrologyObjectClearMetrologyObjectclear_metrology_objectT_clear_metrology_object🔗

Short description🔗

clear_metrology_objectClearMetrologyObjectClearMetrologyObjectclear_metrology_objectT_clear_metrology_object — Delete metrology objects and free the allocated memory.

Signature🔗

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

Herror T_clear_metrology_object( 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)

void HMetrologyModel.ClearMetrologyObject( HTuple index )

void HMetrologyModel.ClearMetrologyObject( string index )

Description🔗

clear_metrology_objectClearMetrologyObject deletes in a metrology model metrology objects created, e.g, by add_metrology_object_circle_measureAddMetrologyObjectCircleMeasure, add_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasure, add_metrology_object_line_measureAddMetrologyObjectLineMeasure, or add_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2Measure.

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 MetrologyHandlemetrologyHandlemetrology_handle. The index of the metrology objects is passed in Indexindexindex. If Indexindexindex is set to 'all'"all", all metrology objects are deleted. After the operator call the metrology objects are invalid.

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

Module🔗

2D Metrology