set_sample_identifier_object_infoT_set_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoset_sample_identifier_object_info (Operator)

Name

set_sample_identifier_object_infoT_set_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoset_sample_identifier_object_info — Define a name or a description for an object of a sample identifier.

Signature

set_sample_identifier_object_info( : : SampleIdentifier, ObjectIdx, InfoName, InfoValue : )

Herror T_set_sample_identifier_object_info(const Htuple SampleIdentifier, const Htuple ObjectIdx, const Htuple InfoName, const Htuple InfoValue)

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)

static void HOperatorSet.SetSampleIdentifierObjectInfo(HTuple sampleIdentifier, HTuple objectIdx, HTuple infoName, HTuple infoValue)

void HSampleIdentifier.SetSampleIdentifierObjectInfo(HTuple objectIdx, string infoName, HTuple infoValue)

void HSampleIdentifier.SetSampleIdentifierObjectInfo(int objectIdx, string infoName, string infoValue)

def set_sample_identifier_object_info(sample_identifier: HHandle, object_idx: MaybeSequence[Union[int, str]], info_name: str, info_value: MaybeSequence[str]) -> None

Description

set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoset_sample_identifier_object_info sets information like a name or a description for an object of the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier. This information can then be retrieved with get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info.

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 InfoNameInfoNameInfoNameInfoNameinfoNameinfo_name to 'preparation_object_name'"preparation_object_name""preparation_object_name""preparation_object_name""preparation_object_name""preparation_object_name". To set information for training objects, set InfoNameInfoNameInfoNameInfoNameinfoNameinfo_name to 'training_object_name'"training_object_name""training_object_name""training_object_name""training_object_name""training_object_name". The information itself is set with the parameter InfoValueInfoValueInfoValueInfoValueinfoValueinfo_value.

Execution Information

Parameters

SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier (input_control)  sample_identifier HSampleIdentifier, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the sample identifier.

ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_idx (input_control)  integer(-array) HTupleMaybeSequence[Union[int, str]]HTupleHtuple (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

InfoNameInfoNameInfoNameInfoNameinfoNameinfo_name (input_control)  attribute.name HTuplestrHTupleHtuple (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" "training_object_name"

List of values: 'preparation_object_name'"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""training_object_name"

InfoValueInfoValueInfoValueInfoValueinfoValueinfo_value (input_control)  attribute.value(-array) HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Information about the object.

Result

If the parameters are valid, the operator set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoset_sample_identifier_object_info returns the value TRUE. If necessary an exception is raised.

Possible Predecessors

add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_data, add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataadd_sample_identifier_training_data

See also

create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifiercreate_sample_identifier, prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierPrepareSampleIdentifierprepare_sample_identifier, train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifierTrainSampleIdentifiertrain_sample_identifier, apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifierapply_sample_identifier, get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info, set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParamSetSampleIdentifierParamset_sample_identifier_param, get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamGetSampleIdentifierParamget_sample_identifier_param, get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info, remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data, remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_data, write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierWriteSampleIdentifierwrite_sample_identifier, read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierReadSampleIdentifierread_sample_identifier, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierSerializeSampleIdentifierserialize_sample_identifier, deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierDeserializeSampleIdentifierdeserialize_sample_identifier, clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierClearSampleIdentifierclear_sample_identifier

Module

Matching