Skip to content

clear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResultclear_surface_matching_resultT_clear_surface_matching_result🔗

Short description🔗

clear_surface_matching_resultClearSurfaceMatchingResultClearSurfaceMatchingResultclear_surface_matching_resultT_clear_surface_matching_result — Free the memory of a surface matching result.

Signature🔗

clear_surface_matching_result( surface_matching_result SurfaceMatchingResultID )void ClearSurfaceMatchingResult( const HTuple& SurfaceMatchingResultID )static void HOperatorSet.ClearSurfaceMatchingResult( HTuple surfaceMatchingResultID )def clear_surface_matching_result( surface_matching_result_id: MaybeSequence[HHandle] ) -> None

Herror T_clear_surface_matching_result( const Htuple SurfaceMatchingResultID )

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

void HSurfaceMatchingResult::ClearSurfaceMatchingResult( ) const

static void HSurfaceMatchingResult.ClearSurfaceMatchingResult( HSurfaceMatchingResult[] surfaceMatchingResultID )

void HSurfaceMatchingResult.ClearSurfaceMatchingResult( )

Description🔗

The operator clear_surface_matching_resultClearSurfaceMatchingResult frees the memory of a surface matching result that was created by find_surface_modelFindSurfaceModel or refine_surface_model_poseRefineSurfaceModelPose. After calling clear_surface_matching_resultClearSurfaceMatchingResult, the result can no longer be used. The handle SurfaceMatchingResultIDsurfaceMatchingResultIDsurface_matching_result_id becomes 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🔗

SurfaceMatchingResultIDsurfaceMatchingResultIDsurface_matching_result_id (input_control, state is modified) surface_matching_result(-array) → (handle)HTuple (HHandle)HSurfaceMatchingResult, HTuple (IntPtr)MaybeSequence[HHandle]Htuple (handle)

Handle of the surface matching result.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

find_surface_modelFindSurfaceModel, refine_surface_model_poseRefineSurfaceModelPose

See also

find_surface_modelFindSurfaceModel, refine_surface_model_poseRefineSurfaceModelPose

Module🔗

3D Metrology