GetRelativesCommand Object


Description:

Gets the relatives of an object.

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

GetRelativesCommand Writable Attributes

Attribute Description
Common Writable Attributes Active, Name, ProgressCancelled
Config

Object handle to get relatives from.

Type: handle

Default: 0

Direction

Direction of the relations. There are three choices: destination, source, and bidirectional. There are several equivalent enum for each choice, as follows:

destination = forward = children = child = downward = down

source = backward = parent = upward = up

bidirectional = both = all

Type: enum

Default: DESTINATION

Possible Values:

Value Description
DESTINATION

Destination

CHILD

Child

CHILDREN

Children

DOWN

Down

DOWNWARD

Downward

FORWARD

Forward

SOURCE

Source

PARENT

Parent

UP

Up

UPWARD

Upward

BACKWARD

Backward

BIDIRECTIONAL

Bidirectional

BOTH

Both

ALL

All

RelationType

Relation type.

Type: string

Default: ParentChild

GetRelativesCommand Read-Only Attributes

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

After command completes, this list will contain a list of relatives.

Type: handle

Default: 0