Skip to content

clear_sheet_of_light_modelClearSheetOfLightModelClearSheetOfLightModelclear_sheet_of_light_modelT_clear_sheet_of_light_model🔗

Short description🔗

clear_sheet_of_light_modelClearSheetOfLightModelClearSheetOfLightModelclear_sheet_of_light_modelT_clear_sheet_of_light_model — Delete a sheet-of-light model and free the allocated memory.

Signature🔗

clear_sheet_of_light_model( sheet_of_light_model SheetOfLightModelID )void ClearSheetOfLightModel( const HTuple& SheetOfLightModelID )static void HOperatorSet.ClearSheetOfLightModel( HTuple sheetOfLightModelID )def clear_sheet_of_light_model( sheet_of_light_model_id: HHandle ) -> None

Herror T_clear_sheet_of_light_model( const Htuple SheetOfLightModelID )

void HSheetOfLightModel::ClearSheetOfLightModel( ) const

void HSheetOfLightModel.ClearSheetOfLightModel( )

Description🔗

The operator clear_sheet_of_light_modelClearSheetOfLightModel deletes a sheet-of-light model that was created by create_sheet_of_light_modelCreateSheetOfLightModel. All memory used by the model is freed. The handle of the model is passed in SheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id. After the operator call it is 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🔗

SheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id (input_control, state is modified) sheet_of_light_model → (handle)HTuple (HHandle)HSheetOfLightModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the sheet-of-light model.

Result🔗

The operator clear_sheet_of_light_modelClearSheetOfLightModel returns the value 2 (H_MSG_TRUE) if a valid handle is passed and the referred sheet-of-light model can be freed correctly. Otherwise, an exception will be raised.

Combinations with other operators🔗

Combinations

See also

create_sheet_of_light_modelCreateSheetOfLightModel

Module🔗

3D Metrology