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
Description
The operator clear_surface_matching_resultclear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResultclear_surface_matching_result frees the memory of a
surface matching result that was created by find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelfind_surface_model or
refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoserefine_surface_model_pose.
After calling clear_surface_matching_resultclear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResultclear_surface_matching_result, the result can no longer
be used. The handle SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultIDsurface_matching_result_id 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:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultIDsurface_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_resultClearSurfaceMatchingResultClearSurfaceMatchingResultclear_surface_matching_result returns the value 2 (
H_MSG_TRUE)
.
If necessary an exception is raised.
Possible Predecessors
find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelfind_surface_model,
refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoserefine_surface_model_pose
See also
find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelfind_surface_model,
refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoserefine_surface_model_pose
Module
3D Metrology