Skip to content

serialize_ncc_modelSerializeNccModelSerializeNccModelserialize_ncc_modelT_serialize_ncc_model🔗

Short description🔗

serialize_ncc_modelSerializeNccModelSerializeNccModelserialize_ncc_modelT_serialize_ncc_model — Serialize an NCC model.

Signature🔗

serialize_ncc_model( ncc_model ModelID, out serialized_item SerializedItemHandle )void SerializeNccModel( const HTuple& ModelID, HTuple* SerializedItemHandle )static void HOperatorSet.SerializeNccModel( HTuple modelID, out HTuple serializedItemHandle )def serialize_ncc_model( model_id: HHandle ) -> HHandle

Herror T_serialize_ncc_model( const Htuple ModelID, Htuple* SerializedItemHandle )

HSerializedItem HNCCModel::SerializeNccModel( ) const

HSerializedItem HNCCModel.SerializeNccModel( )

Description🔗

serialize_ncc_modelSerializeNccModel serializes the data of an NCC 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_ncc_modelWriteNccModel is converted to a serialized item. The NCC model is defined by the handle ModelIDmodelIDmodel_id. The serialized NCC model is returned by the handle SerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_ncc_modelDeserializeNccModel.

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) ncc_model → (handle)HTuple (HHandle)HNCCModel, 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_ncc_modelSerializeNccModel returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_ncc_modelCreateNccModel

Possible successors

fwrite_serialized_itemFwriteSerializedItem, send_serialized_itemSendSerializedItem, deserialize_ncc_modelDeserializeNccModel

Module🔗

Matching