set_sample_identifier_object_infoT_set_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo (Operator)
Name
set_sample_identifier_object_infoT_set_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo — Define a name or a description for an object of a sample identifier.
Signature
void SetSampleIdentifierObjectInfo(const HTuple& SampleIdentifier, const HTuple& ObjectIdx, const HTuple& InfoName, const HTuple& InfoValue)
void HSampleIdentifier::SetSampleIdentifierObjectInfo(const HTuple& ObjectIdx, const HString& InfoName, const HTuple& InfoValue) const
void HSampleIdentifier::SetSampleIdentifierObjectInfo(Hlong ObjectIdx, const HString& InfoName, const HString& InfoValue) const
void HSampleIdentifier::SetSampleIdentifierObjectInfo(Hlong ObjectIdx, const char* InfoName, const char* InfoValue) const
void HSampleIdentifier::SetSampleIdentifierObjectInfo(Hlong ObjectIdx, const wchar_t* InfoName, const wchar_t* InfoValue) const
(Windows only)
Description
set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo sets information like a name or a
description for an object of the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier. This information
can then be retrieved with get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo.
For an explanation of the concept of sample-based identification
see the introduction of chapter Identification / Sample-Based.
To set information for preparation objects, set InfoNameInfoNameInfoNameInfoNameinfoName to
'preparation_object_name'"preparation_object_name""preparation_object_name""preparation_object_name""preparation_object_name". To set information for training
objects, set InfoNameInfoNameInfoNameInfoNameinfoName to 'training_object_name'"training_object_name""training_object_name""training_object_name""training_object_name". The
information itself is set with the parameter InfoValueInfoValueInfoValueInfoValueinfoValue.
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 → HSampleIdentifier, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the sample identifier.
ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx (input_control) integer(-array) → HTupleHTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)
Index of the object for which information is set.
Suggested values: 0, 1, 2, 3, 4, 5
InfoNameInfoNameInfoNameInfoNameinfoName (input_control) attribute.name → HTupleHTupleHtuple (string) (string) (HString) (char*)
Define, for which kind of object information is set.
Default value:
'training_object_name'
"training_object_name"
"training_object_name"
"training_object_name"
"training_object_name"
List of values: 'preparation_object_name'"preparation_object_name""preparation_object_name""preparation_object_name""preparation_object_name", 'training_object_name'"training_object_name""training_object_name""training_object_name""training_object_name"
InfoValueInfoValueInfoValueInfoValueinfoValue (input_control) attribute.value(-array) → HTupleHTupleHtuple (string) (string) (HString) (char*)
Information about the object.
Result
If the parameters are valid, the operator
set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo returns the value 2 (H_MSG_TRUE). If
necessary an exception is raised.
Possible Predecessors
add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationData,
add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData
See also
create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier,
prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierPrepareSampleIdentifier,
train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifierTrainSampleIdentifier,
apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifier,
get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo,
set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParamSetSampleIdentifierParam,
get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamGetSampleIdentifierParam,
get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo,
remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData,
remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData,
write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierWriteSampleIdentifier,
read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierReadSampleIdentifier,
serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierSerializeSampleIdentifier,
deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierDeserializeSampleIdentifier,
clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierClearSampleIdentifier
Module
Matching