ClassesClassesClassesClasses | | | | Operators

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

clear_metrology_object( : : MetrologyHandle, Indices : )

Herror clear_metrology_object(const Hlong MetrologyHandle, const char* Indices)

Herror T_clear_metrology_object(const Htuple MetrologyHandle, const Htuple Indices)

Herror clear_metrology_object(const HTuple& MetrologyHandle, const HTuple& Indices)

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

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

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

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

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

void HOperatorSetX.ClearMetrologyObject(
[in] VARIANT MetrologyHandle, [in] VARIANT Indices)

void HMetrologyModelX.ClearMetrologyObject([in] VARIANT Indices)

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

void HMetrologyModel.ClearMetrologyObject(HTuple indices)

void HMetrologyModel.ClearMetrologyObject(string indices)

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, add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measure, or copy_metrology_objectcopy_metrology_objectCopyMetrologyObjectcopy_metrology_objectCopyMetrologyObjectCopyMetrologyObject (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 indices of the metrology objects are passed in IndicesIndicesIndicesIndicesIndicesindices. If IndicesIndicesIndicesIndicesIndicesindices is set to 'all'"all""all""all""all""all", all metrology objects are deleted. After the operator call the metrology objects are invalid.

Attention

A metrology model 'MetrologyHandle'"MetrologyHandle""MetrologyHandle""MetrologyHandle""MetrologyHandle""MetrologyHandle" cannot be shared between two or more user's threads. Different metrology models can be used independently and safely in different threads.

Parallelization

Parameters

MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle (input_control)  metrology_model HMetrologyModel, HTupleHTupleHMetrologyModel, HTupleHMetrologyModelX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the metrology model.

IndicesIndicesIndicesIndicesIndicesindices (input_control)  integer(-array) HTupleHTupleHTupleVARIANTHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong) (BSTR / Hlong) (char* / Hlong)

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

Possible Predecessors

copy_metrology_objectcopy_metrology_objectCopyMetrologyObjectcopy_metrology_objectCopyMetrologyObjectCopyMetrologyObject

Module

2D Metrology


ClassesClassesClassesClasses | | | | Operators