DEFINE COMPOSITE EVENT

Description

DEFINE COMPOSITE EVENT defines a composite event to BTS. A composite event is formed from zero or more atomic events known as sub-events.

DEFINE COMPOSITE EVENT defines a predicate, which is a logical expression involving sub-events. At all times, the composite event's fire status (FIRED or NOTFIRED) reflects the value of the predicate. When the predicate becomes true, the composite event fires; when it becomes false, the composite's fire status reverts to NOTFIRED.

The logical operator that is applied to the sub-events in the composite event's predicate is one of the Boolean operators AND or OR. AND and OR cannot both be used.

You can specify up to 8 sub-events to be added to the composite event when the composite is created. If you do not specify any sub-events, the composite event is defined as empty—that is, as containing no sub-events.

To add sub-events to a composite event after the composite has been defined, use the ADD SUBEVENT command. There is no limit to the number of sub-events that you can add using ADD SUBEVENT.

To remove sub-events from a composite event, use the REMOVE SUBEVENT command.

Options

AND

specifies that the Boolean operator to be associated with this composite's predicate is AND. This means that the composite event will fire when all of its sub-events have fired.

Note: The fire status of an empty composite event that uses the AND operator is always FIRED (true).

EVENT(data-value)

specifies the name (1–16 characters) of the composite event being defined. The acceptable characters are A-Z a-z 0-9 $ @ # . - and _. Leading and embedded blank characters are not permitted. If the name supplied is less than 16 characters, it is padded with trailing blanks up to 16 characters.

OR

specifies that the Boolean operator to be associated with this composite's predicate is OR. This means that the composite event will fire when any of its sub-events fires.

Note: The fire status of an empty composite event that uses the OR operator is always NOTFIRED (false).

SUBEVENTn(data-value)

specifies the name (1–16 characters) of a sub-event to be added to the composite event when the composite is created. The acceptable characters are A-Z a-z 0-9 $ @ # . - and _. Leading and embedded blank characters are not permitted. If the name supplied is less than 16 characters, it is padded with trailing blanks up to 16 characters.

You can specify this option up to 8 times; n must be in the range 1–8.

The sub-events that you specify must previously have been defined to the current activity by means of DEFINE INPUT EVENT, DEFINE ACTIVITY, or DEFINE TIMER commands. They must not be sub-events of existing composite events.

Conditions

111 EVENTERR

RESP2 values:

6

The event name specified on the EVENT option is invalid.

7

The event name specified on the EVENT option has already been defined to this activity.

21–28

One or more of the sub-events named on the SUBEVENTn option does not exist. The RESP2 value indicates the first sub-event that does not exist.

16 INVREQ

RESP2 values:

1

The command was issued outside the scope of an activity.

31–38

One or more of the sub-events names specified on the SUBEVENTn option is invalid. The RESP2 value indicates the first invalid sub-event name.