Skip to content

serialize_sheet_of_light_modelSerializeSheetOfLightModelSerializeSheetOfLightModelserialize_sheet_of_light_modelT_serialize_sheet_of_light_model🔗

Short description🔗

serialize_sheet_of_light_modelSerializeSheetOfLightModelSerializeSheetOfLightModelserialize_sheet_of_light_modelT_serialize_sheet_of_light_model — Serialize a sheet-of-light model.

Signature🔗

serialize_sheet_of_light_model( sheet_of_light_model SheetOfLightModelID, out serialized_item SerializedItemHandle )void SerializeSheetOfLightModel( const HTuple& SheetOfLightModelID, HTuple* SerializedItemHandle )static void HOperatorSet.SerializeSheetOfLightModel( HTuple sheetOfLightModelID, out HTuple serializedItemHandle )def serialize_sheet_of_light_model( sheet_of_light_model_id: HHandle ) -> HHandle

Herror T_serialize_sheet_of_light_model( const Htuple SheetOfLightModelID, Htuple* SerializedItemHandle )

HSerializedItem HSheetOfLightModel::SerializeSheetOfLightModel( ) const

HSerializedItem HSheetOfLightModel.SerializeSheetOfLightModel( )

Description🔗

serialize_sheet_of_light_modelSerializeSheetOfLightModel serializes a sheet-of-light model (see fwrite_serialized_itemFwriteSerializedItem for an introduction of the basic principle of serialization). The same data that is written in a file by write_sheet_of_light_modelWriteSheetOfLightModel is converted to a serialized item. The sheet-of-light model is defined by the handle SheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id. The serialized model is returned by the handle SerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_sheet_of_light_modelDeserializeSheetOfLightModel.

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.

Parameters🔗

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

Handle of the sheet-of-light model.

SerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → (handle)HTuple (HHandle)HSerializedItem, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the serialized item.

Result🔗

The operator serialize_sheet_of_light_modelSerializeSheetOfLightModel returns the value 2 (H_MSG_TRUE) if the passed handle of the sheet-of-light model is valid and if the model can be serialized into the serialized item. Otherwise, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_sheet_of_light_modelCreateSheetOfLightModel, set_sheet_of_light_paramSetSheetOfLightParam

Possible successors

fwrite_serialized_itemFwriteSerializedItem, send_serialized_itemSendSerializedItem, deserialize_sheet_of_light_modelDeserializeSheetOfLightModel

See also

deserialize_sheet_of_light_modelDeserializeSheetOfLightModel

Module🔗

3D Metrology