Skip to content

reset_sheet_of_light_modelResetSheetOfLightModelResetSheetOfLightModelreset_sheet_of_light_modelT_reset_sheet_of_light_model🔗

Short description🔗

reset_sheet_of_light_modelResetSheetOfLightModelResetSheetOfLightModelreset_sheet_of_light_modelT_reset_sheet_of_light_model — Reset a sheet-of-light model.

Signature🔗

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

Herror T_reset_sheet_of_light_model( const Htuple SheetOfLightModelID )

void HSheetOfLightModel::ResetSheetOfLightModel( ) const

void HSheetOfLightModel.ResetSheetOfLightModel( )

Description🔗

The operator reset_sheet_of_light_modelResetSheetOfLightModel resets a sheet-of-light model that was created by create_sheet_of_light_modelCreateSheetOfLightModel. All indices and result arrays used by the model are reset. The parameters of the model remain unchanged. The handle of the model is passed in SheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id.

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 reset_sheet_of_light_modelResetSheetOfLightModel returns the value 2 (H_MSG_TRUE) if a valid handle is passed and the sheet-of-light model can be reset correctly. Otherwise, an exception will be raised.

Combinations with other operators🔗

Combinations

See also

clear_sheet_of_light_modelClearSheetOfLightModel

Module🔗

3D Metrology