Description:
Adds relatives to a single object.
Can be used with Command Sequencer: No
| Attribute | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Common Writable Attributes | Active, Name, ProgressCancelled | ||||||||||||||||||||||||||||||
| Config |
Handle of the object that will have relatives added to it. You specify the relatives with the RelativesList attribute. 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:
|
||||||||||||||||||||||||||||||
| RelationType |
Type of relation to set. Type: string Default: ParentChild |
||||||||||||||||||||||||||||||
| RelativesList |
List of relatives to add to the object specified by the Config attribute. A relation is added only if it does not already exist. Type: handle Default: 0 |
||||||||||||||||||||||||||||||
| RemoveAll |
Whether to remove all children from an object that is being replaced. For example, you are adding a new Port child to a Project object that already has three other Port children. If RemoveAll is set to TRUE, all three existing Port children will be removed and the new Port object will replace them. If RemoveAll is set to FALSE, the three existing Port children will remain and the new Port object will be added to the list of children. Type: bool Default: TRUE Possible Values:
|
| Read-Only Attribute | Description |
|---|---|
| Common Read-Only Attributes | ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status |