Skip to content

clear_bead_inspection_modelClearBeadInspectionModelClearBeadInspectionModelclear_bead_inspection_modelT_clear_bead_inspection_model🔗

Short description🔗

clear_bead_inspection_modelClearBeadInspectionModelClearBeadInspectionModelclear_bead_inspection_modelT_clear_bead_inspection_model — Delete the bead inspection model and free the allocated memory.

Signature🔗

clear_bead_inspection_model( bead_inspection_model BeadInspectionModel )void ClearBeadInspectionModel( const HTuple& BeadInspectionModel )static void HOperatorSet.ClearBeadInspectionModel( HTuple beadInspectionModel )def clear_bead_inspection_model( bead_inspection_model: HHandle ) -> None

Herror T_clear_bead_inspection_model( const Htuple BeadInspectionModel )

void HBeadInspectionModel::ClearBeadInspectionModel( ) const

void HBeadInspectionModel.ClearBeadInspectionModel( )

Description🔗

The operator clear_bead_inspection_modelClearBeadInspectionModel deletes a bead inspection model that was created by create_bead_inspection_modelCreateBeadInspectionModel. All memory used by the model is freed. The handle of the model is passed in BeadInspectionModelbeadInspectionModelbead_inspection_model. It is invalid after the operator call.

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🔗

BeadInspectionModelbeadInspectionModelbead_inspection_model (input_control, state is modified) bead_inspection_model → (handle)HTuple (HHandle)HBeadInspectionModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the bead inspection model.

Result🔗

The operator clear_bead_inspection_modelClearBeadInspectionModel returns the value 2 (H_MSG_TRUE) if a valid handle is passed and the referred bead inspection model can be freed correctly. Otherwise, an exception will be raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_bead_inspection_modelCreateBeadInspectionModel

See also

create_bead_inspection_modelCreateBeadInspectionModel

Module🔗

2D Metrology