reset_sheet_of_light_modelreset_sheet_of_light_modelResetSheetOfLightModelreset_sheet_of_light_modelResetSheetOfLightModelResetSheetOfLightModel (Operator)

Name

reset_sheet_of_light_modelreset_sheet_of_light_modelResetSheetOfLightModelreset_sheet_of_light_modelResetSheetOfLightModelResetSheetOfLightModel — Reset a sheet-of-light model.

Signature

reset_sheet_of_light_model( : : SheetOfLightModelID : )

Description

The operator reset_sheet_of_light_modelreset_sheet_of_light_modelResetSheetOfLightModelreset_sheet_of_light_modelResetSheetOfLightModelResetSheetOfLightModel resets a sheet-of-light model that was created by create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModel. 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 SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID.

This operator changes the data in the handle. Therefore one and the same sheet-of-light model cannot be used concurrently in different threads when using this operator. If you want to use the same handle in multiple threads you have to synchronize the threads to assure that they do not access the same handle simultaneously. Different sheet-of-light models can be used independently and safely in different threads.

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID (input_control) sheet_of_light_model → (integer)

Handle of the sheet-of-light model.

Result

The operator reset_sheet_of_light_modelreset_sheet_of_light_modelResetSheetOfLightModelreset_sheet_of_light_modelResetSheetOfLightModelResetSheetOfLightModel 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.

Module

3D Metrology

Operators