SetRelationCommand Object

HOME | TECHNOLOGIES | TEST CONFIGURATION | SEQUENCER COMMANDS | GUI COMMAND NAMES | ALL COMMANDS | RESULT | PDU | ALL | OBJECT TREE

Description:

Sets relations between objects.

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

SetRelationCommand Writable Attributes

Attribute Description
Common Writable Attributes Active, Name, ProgressCancelled
RelationIdList

This attribute, SrcList, and TargetList are parallel arrays. The nth object in SrcList is related to the nth object in TargetList using the nth RelationId in this list.

Type: relationId

Default: 1
RemoveAll

Whether to remove existing relation of specified object between objects first.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Remove existing relations.
FALSE

Remove no relations.
SrcList

RelationIdList, this attribute, and TargetList are parallel arrays. The nth object in this list is related to the nth object in TargetList using the nth RelationId in the RelationIdList list.

Type: handle

Default: 0
SrcTargetMapping

Type of mapping to use for adding relation between source and target list objects.

Type: enum

Default: ONE_SRC_TO_ONE_TARGET

Possible Values:

Value Description
ONE_SRC_TO_ONE_TARGET

One source object to one target object. All input lists must be of the same size including relationId.
EACH_SRC_TO_ALL_TARGET

Each source object to all target objects. RelationIdList and TargetList must be the same size or RelationIdList size must be 1.
EACH_TARGET_TO_ALL_SRC

Each target object to all source objects. RelationIdList and SrcList must be the same size or RelationIdList size must be 1.

TargetList

RelationIdList, SrcList, and this attribute are parallel arrays. The nth object in SrcList is related to the nth object in this list using the nth RelationId in the RelationIdList list.

Type: handle

Default: 0

SetRelationCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status