clear_surface_matching_resultT_clear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResultclear_surface_matching_result (Operator)

Name

clear_surface_matching_resultT_clear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResultclear_surface_matching_result — Free the memory of a surface matching result.

Signature

clear_surface_matching_result( : : SurfaceMatchingResultID : )

Herror T_clear_surface_matching_result(const Htuple SurfaceMatchingResultID)

void ClearSurfaceMatchingResult(const HTuple& SurfaceMatchingResultID)

static void HSurfaceMatchingResult::ClearSurfaceMatchingResult(const HSurfaceMatchingResultArray& SurfaceMatchingResultID)

void HSurfaceMatchingResult::ClearSurfaceMatchingResult() const

static void HOperatorSet.ClearSurfaceMatchingResult(HTuple surfaceMatchingResultID)

static void HSurfaceMatchingResult.ClearSurfaceMatchingResult(HSurfaceMatchingResult[] surfaceMatchingResultID)

void HSurfaceMatchingResult.ClearSurfaceMatchingResult()

def clear_surface_matching_result(surface_matching_result_id: MaybeSequence[HHandle]) -> None

Description

The operator clear_surface_matching_resultclear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResultClearSurfaceMatchingResultclear_surface_matching_result frees the memory of a surface matching result that was created by find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModelfind_surface_model or refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoseRefineSurfaceModelPoserefine_surface_model_pose. After calling clear_surface_matching_resultclear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResultClearSurfaceMatchingResultclear_surface_matching_result, the result can no longer be used. The handle SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultIDsurface_matching_result_id becomes 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

SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultIDsurface_matching_result_id (input_control, state is modified)  surface_matching_result(-array) HSurfaceMatchingResult, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the surface matching result.

Result

If the handle of the result is valid, the operator clear_surface_matching_resultclear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResultClearSurfaceMatchingResultclear_surface_matching_result returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModelfind_surface_model, refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoseRefineSurfaceModelPoserefine_surface_model_pose

See also

find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModelfind_surface_model, refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoseRefineSurfaceModelPoserefine_surface_model_pose

Module

3D Metrology