serialize_measureT_serialize_measureSerializeMeasureSerializeMeasure (Operator)

Name

serialize_measureT_serialize_measureSerializeMeasureSerializeMeasure — Serialize a measure object.

Signature

serialize_measure( : : MeasureHandle : SerializedItemHandle)

Description

serialize_measureserialize_measureSerializeMeasureSerializeMeasureSerializeMeasure serializes the data of a measure object (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem for an introduction of the basic principle of serialization). The same data that is written in a file by write_measurewrite_measureWriteMeasureWriteMeasureWriteMeasure is converted to a serialized item. The measure object is defined by the handle MeasureHandleMeasureHandleMeasureHandleMeasureHandlemeasureHandle. The serialized measure object is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle and can be deserialized by deserialize_measuredeserialize_measureDeserializeMeasureDeserializeMeasureDeserializeMeasure.

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:

MeasureHandleMeasureHandleMeasureHandleMeasureHandlemeasureHandle

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

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

Measure object handle.

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (output_control) serialized_item → (handle)

Handle of the serialized item.

Result

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