serialize_measureT_serialize_measureSerializeMeasureSerializeMeasureserialize_measure (Operator)

Name

serialize_measureT_serialize_measureSerializeMeasureSerializeMeasureserialize_measure — Serialize a measure object.

Signature

serialize_measure( : : MeasureHandle : SerializedItemHandle)

Description

serialize_measureserialize_measureSerializeMeasureSerializeMeasureserialize_measure serializes the data of a measure object (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item for an introduction of the basic principle of serialization). The same data that is written in a file by write_measurewrite_measureWriteMeasureWriteMeasurewrite_measure is converted to a serialized item. The measure object is defined by the handle MeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle. The serialized measure object is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_measuredeserialize_measureDeserializeMeasureDeserializeMeasuredeserialize_measure.

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

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:

MeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle

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

Parameters

MeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle (input_control, state is modified) measure → (handle)

Measure object handle.

SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → (handle)

Handle of the serialized item.

Result

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