Skip to content

serialize_shape_modelSerializeShapeModelSerializeShapeModelserialize_shape_modelT_serialize_shape_model🔗

Short description🔗

serialize_shape_modelSerializeShapeModelSerializeShapeModelserialize_shape_modelT_serialize_shape_model — Serialize a shape model.

Signature🔗

serialize_shape_model( shape_model ModelID, out serialized_item SerializedItemHandle )void SerializeShapeModel( const HTuple& ModelID, HTuple* SerializedItemHandle )static void HOperatorSet.SerializeShapeModel( HTuple modelID, out HTuple serializedItemHandle )def serialize_shape_model( model_id: HHandle ) -> HHandle

Herror T_serialize_shape_model( const Htuple ModelID, Htuple* SerializedItemHandle )

HSerializedItem HShapeModel::SerializeShapeModel( ) const

HSerializedItem HShapeModel.SerializeShapeModel( )

Description🔗

serialize_shape_modelSerializeShapeModel serializes the data of a shape 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_shape_modelWriteShapeModel is converted to a serialized item. The shape model is defined by the handle ModelIDmodelIDmodel_id. The serialized shape model is returned by the handle SerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_shape_modelDeserializeShapeModel.

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🔗

ModelIDmodelIDmodel_id (input_control) shape_model → (handle)HTuple (HHandle)HShapeModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the model.

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

Handle of the serialized item.

Result🔗

If the parameters are valid, the operator serialize_shape_modelSerializeShapeModel returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_generic_shape_modelCreateGenericShapeModel

Possible successors

fwrite_serialized_itemFwriteSerializedItem, send_serialized_itemSendSerializedItem, deserialize_shape_modelDeserializeShapeModel

Module🔗

Matching