clear_surface_matching_resultT_clear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResult (Operator)

Name

clear_surface_matching_resultT_clear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResult — Free the memory of a surface matching result.

Signature

clear_surface_matching_result( : : SurfaceMatchingResultID : )

Description

The operator clear_surface_matching_resultclear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResultClearSurfaceMatchingResult frees the memory of a surface matching result that was created by find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel or refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoseRefineSurfaceModelPose. After calling clear_surface_matching_resultclear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResultClearSurfaceMatchingResult, the result can no longer be used. The handle SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID becomes invalid.

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:

SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID (input_control, state is modified) surface_matching_result(-array) → (handle)

Handle of the surface matching result.

Result

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

Possible Predecessors

find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel, refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoseRefineSurfaceModelPose

Module

3D Metrology

Operators