Skip to content

serialize_measureSerializeMeasureSerializeMeasureserialize_measureT_serialize_measure🔗

Short description🔗

serialize_measureSerializeMeasureSerializeMeasureserialize_measureT_serialize_measure — Serialize a measure object.

Signature🔗

serialize_measure( measure MeasureHandle, out serialized_item SerializedItemHandle )void SerializeMeasure( const HTuple& MeasureHandle, HTuple* SerializedItemHandle )static void HOperatorSet.SerializeMeasure( HTuple measureHandle, out HTuple serializedItemHandle )def serialize_measure( measure_handle: HHandle ) -> HHandle

Herror T_serialize_measure( const Htuple MeasureHandle, Htuple* SerializedItemHandle )

HSerializedItem HMeasure::SerializeMeasure( ) const

HSerializedItem HMeasure.SerializeMeasure( )

Description🔗

serialize_measureSerializeMeasure serializes the data of a measure object (see fwrite_serialized_itemFwriteSerializedItem for an introduction of the basic principle of serialization). The same data that is written in a file by write_measureWriteMeasure is converted to a serialized item. The measure object is defined by the handle MeasureHandlemeasureHandlemeasure_handle. The serialized measure object is returned by the handle SerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_measureDeserializeMeasure.

For an explanation of the concept of 1D measuring see the introduction of chapter 1D Measuring.

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.

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters🔗

MeasureHandlemeasureHandlemeasure_handle (input_control, state is modified) measure → (handle)HTuple (HHandle)HMeasure, HTuple (IntPtr)HHandleHtuple (handle)

Measure object handle.

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

Combinations with other operators🔗

Combinations

Possible predecessors

gen_measure_rectangle2GenMeasureRectangle2, gen_measure_arcGenMeasureArc

Possible successors

fwrite_serialized_itemFwriteSerializedItem, send_serialized_itemSendSerializedItem, deserialize_measureDeserializeMeasure

See also

read_measureReadMeasure, write_measureWriteMeasure

Module🔗

1D Metrology