serialize_sample_identifierT_serialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifier (Operator)

Name

serialize_sample_identifierT_serialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifier — Serialize a sample identifier.

Signature

serialize_sample_identifier( : : SampleIdentifier : SerializedItemHandle)

Description

serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierSerializeSampleIdentifier serializes the data of a sample identifier (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_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierWriteSampleIdentifier is converted to a serialized item. The sample identifier is defined by the handle SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier. The serialized sample identifier is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle and can be deserialized by deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierDeserializeSampleIdentifier.

For an explanation of the concept of sample-based identification see the introduction of chapter Identification / Sample-Based.

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

SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier (input_control) sample_identifier → (handle)

Handle of the sample identifier.

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (output_control) serialized_item → (handle)

Handle of the serialized item.

Result

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

Possible Predecessors

prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierPrepareSampleIdentifier, train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifierTrainSampleIdentifier, add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationData, add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData, set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParamSetSampleIdentifierParam

Possible Successors

clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierClearSampleIdentifier

Alternatives

write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierWriteSampleIdentifier

Module

Matching

Operators