Operator Reference
serialize_measure (Operator)
serialize_measure
— Serialize a measure object.
Signature
serialize_measure( : : MeasureHandle : SerializedItemHandle)
Description
serialize_measure
serializes the data of a measure object
(see fwrite_serialized_item
for an introduction of the
basic principle of serialization). The same data that is written
in a file by write_measure
is converted to a serialized
item. The measure object is defined by the handle
MeasureHandle
. The serialized measure object is returned
by the handle SerializedItemHandle
and can be
deserialized by deserialize_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:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
MeasureHandle
(input_control, state is modified) measure →
(handle)
Measure object handle.
SerializedItemHandle
(output_control) serialized_item →
(handle)
Handle of the serialized item.
Result
If the parameters are valid, the operator
serialize_measure
returns the value 2 (
H_MSG_TRUE)
. If
necessary, an exception is raised.
Possible Predecessors
gen_measure_rectangle2
,
gen_measure_arc
Possible Successors
fwrite_serialized_item
,
send_serialized_item
,
deserialize_measure
See also
Module
1D Metrology