7.25. SetScheduleAttributeValue

set_schedule_attribute_value ‐ Dynamic modification of the attribute values of a schedule element

7.25.1. Attributes

NameTypeDefaults
indexINTEGERNone (required)
operatorSTRINGNone (required)
variableSTRINGEmpty string

7.25.2. Description

This action is used to modify the values associated with attributes in a schedule element. If the attribute values contain parenthesized expressions, they are dynamically evaluated as numerical expressions and their values are replaced in the attribute value strings. The integer value schedule no of the index attribute defines the rank of the target schedule in the target node. Ranks begin at 1. The string value of the operator attribute is an operator string. The values of the operator must be "=", "=", "+=", "-=", "*=", or "/=". The child node is a schedule element that contains at least one attribute and its associated value.

The attributes of the child node are called source attributes. If the target node contains at least schedule no schedule(s), the values of the source attributes are used to modify the values of the corresponding attributes in the schedule number schedule no of the target node.

For instance if the source schedule contains the attribute begin, and if the operator is "=", the source begin value replace the begin value in the target schedule. The other operators respectively correspond to addition, substraction, multiplication, and division of the target values by the source values. The attributes of the target schedule that are not instantiated in the source schedule element (the child node) are not modified by this action.

Interpolation can also operate on variables (scalars, tables, or matrices). The set_schedule_attribute_value command concern the interpolation of variables if and only if the variable attribute is defined in the set_schedule_attribute_value element. In this case, the string value of the variable attribute is the ID of the interpolated variable on the target node.

7.25.3. Expected children

The following element must occur in set_schedule_attribute_value: one schedule element.

7.25.4. Expected target

The target node must contain a schedule. It must be either an interpolator a circle transformation, a ellipse transformation, a spiral transformation, or a path transformation.

7.25.5. Example

The example below defines an action that modifies the begin time of the third schedule in the target node(s). The begin time is replaced by the current time.

<set_schedule_attribute_value index="3" operator="=">
  <schedule begin="now"/>
</set_schedule_attribute_value>

In the example below, the action modifies the begin time of the first schedule in the interp_scal variable of the target node.

<set_schedule_attribute_value variable="interp_scal" 
                              index="1" operator="=">
  <schedule begin="now" />
</set_schedule_attribute_value>