serialize_surface_modelSerializeSurfaceModelSerializeSurfaceModelserialize_surface_modelT_serialize_surface_model

HALCON ScriptCpp++.NETPythonC

Short description

serialize_surface_modelSerializeSurfaceModelSerializeSurfaceModelserialize_surface_modelT_serialize_surface_model — Serialize a surface_model.

Signature

serialize_surface_model( surface_model SurfaceModelID, out serialized_item SerializedItemHandle )void SerializeSurfaceModel( const HTuple& SurfaceModelID, HTuple* SerializedItemHandle )static void HOperatorSet.SerializeSurfaceModel( HTuple surfaceModelID, out HTuple serializedItemHandle )def serialize_surface_model( surface_model_id: HHandle ) -> HHandle

Herror T_serialize_surface_model( const Htuple SurfaceModelID, Htuple* SerializedItemHandle )

HSerializedItem HSurfaceModel::SerializeSurfaceModel( ) const

HSerializedItem HSurfaceModel.SerializeSurfaceModel( )

Description

serialize_surface_modelSerializeSurfaceModel serializes the data of a surface 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_surface_modelWriteSurfaceModel is converted to a serialized item. The surface model is defined by the handle SurfaceModelIDsurfaceModelIDsurface_model_id. The serialized surface model is returned by the handle SerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_surface_modelDeserializeSurfaceModel.

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

SurfaceModelIDsurfaceModelIDsurface_model_id (input_control) surface_model → (handle)HTuple (HHandle)HSurfaceModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the surface 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_surface_modelSerializeSurfaceModel returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Combinations with other operators

Combinations

Possible predecessors

read_surface_modelReadSurfaceModel, create_surface_modelCreateSurfaceModel, get_surface_model_paramGetSurfaceModelParam

Possible successors

clear_surface_modelClearSurfaceModel, fwrite_serialized_itemFwriteSerializedItem, send_serialized_itemSendSerializedItem, deserialize_surface_modelDeserializeSurfaceModel

See also

create_surface_modelCreateSurfaceModel, read_surface_modelReadSurfaceModel, write_surface_modelWriteSurfaceModel

Module

3D Metrology