Skip to content

clear_component_modelClearComponentModelClearComponentModelclear_component_modelT_clear_component_model🔗

Short description🔗

clear_component_modelClearComponentModelClearComponentModelclear_component_modelT_clear_component_model — Free the memory of a component model.

Warning🔗

clear_component_modelClearComponentModel is obsolete and is only provided for reasons of backward compatibility. The operator will be removed with HALCON 26.11.

Signature🔗

clear_component_model( component_model ComponentModelID )void ClearComponentModel( const HTuple& ComponentModelID )static void HOperatorSet.ClearComponentModel( HTuple componentModelID )def clear_component_model( component_model_id: HHandle ) -> None

Herror T_clear_component_model( const Htuple ComponentModelID )

void HComponentModel::ClearComponentModel( ) const

void HComponentModel.ClearComponentModel( )

Description🔗

The operator clear_component_modelClearComponentModel frees the memory of a component model that was created by create_component_modelCreateComponentModel or create_trained_component_modelCreateTrainedComponentModel. After calling clear_component_modelClearComponentModel, the model can no longer be used. The handle ComponentModelIDcomponentModelIDcomponent_model_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🔗

ComponentModelIDcomponentModelIDcomponent_model_id (input_control, state is modified) component_model → (handle)HTuple (HHandle)HComponentModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the component model.

Result🔗

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

Module🔗

Matching