ClassesClassesClassesClasses | | | | Operators

set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo (Operator)

Name

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

Signature

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

Herror set_sample_identifier_object_info(const Hlong SampleIdentifier, const Hlong ObjectIdx, const char* InfoName, const char* InfoValue)

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

Herror set_sample_identifier_object_info(const HTuple& SampleIdentifier, const HTuple& ObjectIdx, const HTuple& InfoName, const HTuple& InfoValue)

void HSampleIdentifier::SetSampleIdentifierObjectInfo(const HTuple& ObjectIdx, const HTuple& InfoName, const HTuple& InfoValue) const

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 HOperatorSetX.SetSampleIdentifierObjectInfo(
[in] VARIANT SampleIdentifier, [in] VARIANT ObjectIdx, [in] VARIANT InfoName, [in] VARIANT InfoValue)

void HSampleIdentifierX.SetSampleIdentifierObjectInfo(
[in] VARIANT ObjectIdx, [in] BSTR InfoName, [in] VARIANT InfoValue)

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)

Description

set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo sets information like a name or a description for an object of the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier. This information can then be retrieved with get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo.

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 InfoNameInfoNameInfoNameInfoNameInfoNameinfoName 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 InfoNameInfoNameInfoNameInfoNameInfoNameinfoName 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 InfoValueInfoValueInfoValueInfoValueInfoValueinfoValue.

Parallelization

Parameters

SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier (input_control)  sample_identifier HSampleIdentifier, HTupleHTupleHSampleIdentifier, HTupleHSampleIdentifierX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the sample identifier.

ObjectIdxObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx (input_control)  integer(-array) HTupleHTupleHTupleVARIANTHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*) (Hlong / BSTR) (Hlong / char*)

Index of the object for which information is set.

Suggested values: 0, 1, 2, 3, 4, 5

InfoNameInfoNameInfoNameInfoNameInfoNameinfoName (input_control)  attribute.name HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (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"

InfoValueInfoValueInfoValueInfoValueInfoValueinfoValue (input_control)  attribute.value(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Information about the object.

Result

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

Possible Predecessors

add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationData, add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData

See also

create_sample_identifiercreate_sample_identifierCreateSampleIdentifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifier, prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifier, train_sample_identifiertrain_sample_identifierTrainSampleIdentifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifier, apply_sample_identifierapply_sample_identifierApplySampleIdentifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifier, get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo, set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParam, get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParam, get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo, remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData, remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData, write_sample_identifierwrite_sample_identifierWriteSampleIdentifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifier, read_sample_identifierread_sample_identifierReadSampleIdentifierread_sample_identifierReadSampleIdentifierReadSampleIdentifier, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifier, deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifier, clear_sample_identifierclear_sample_identifierClearSampleIdentifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifier

Module

Matching


ClassesClassesClassesClasses | | | | Operators