Event (automation interface)
An Event is a dictionary item that represents a stimulus that causes processing to take place within the system, or a signal that is sent as the result of some processing having taken place within the system.
ATTRIBUTES:
Average Rate
A string showing the Average Rate at which the Event occurs.
Access is read/write.
Change Expression
A string that specifies an expression that must be satisfied to trigger the Event.
The Change Expression attribute applies only when the Event Type is set to 1, that is, Change Event.
Access is read/write.
Description
A textual property that gives an overview of the dictionary item.
Access is read/write.
Detection Lag
A string detailing the Detection Lag between the Event happening and the system detecting it.
Access is read/write.
Deviation
A string showing the deviation between Event occurrences.
Access is read/write.
Duration
A textual property describing the duration of the Event.
Access is read/write.
Event Type
A string that specifies the trigger type of the Event. Possible values are as follows:
• Opaque Event
• Call Event (specify triggering Operation through the Operation association)
• Change Event (specify triggering expression through the Expression attribute)
• Signal Event (specify triggering Signal through the Signal association)
• Time Event (specify triggering criteria through the When attribute)
Access is read/write before changing from the default value. After changing the default value, access is read-only.
Frequency
A string that specifies the frequency with which the Event runs, including the units used.
Access is read/write.
In Bursts
A Boolean property showing if the Event occurs in clusters. Possible values are TRUE or FALSE. If this is set to TRUE, Max Burst Length can also be specified.
Access is read/write.
Is Periodic
A Boolean property indicating whether the Event is periodic. Possible values are TRUE or FALSE.
Access is read/write.
Max Burst Length
An integer property describing the maximum burst length. This can only be specified if the In Bursts property is set to TRUE.
Access is read/write.
Minimum Interval
A string detailing the minimum interval that must occur between Event occurrences.
Access is read/write.
Signature
String, representing the signature of the Event.
Access is read/write.
Synchronisation
A property describing how the Event is synchronized. Possible values are as follows:
• Asynchronous
• Balking
• Call
• Timed
• Waiting
Access is read/write.
When
A string that specifies the criteria that triggers the Event.
The When attribute applies only when the Event Type is set to 4, that is, Time Event.
Access is read/write.
ASSOCIATIONS:
Relationship to Action Nodes (Accept Event Actions only) that use the Event as their Linked Item.
Multiplicity is 0+, access is read/write.
Relationship to Comments that are applied to the Event.
Multiplicity is 0+, access is read/write.
Relationship to Constraints that are applied to the Event.
Multiplicity is 0+, access is read/write.
Relationship to scoping Package.
Multiplicity is 0-1, access is read/write.
Event Action Block
Relationship with Event Action Blocks that use the Event as a trigger.
Multiplicity is 0+, access is read/write.
A relationship with an Operation that is linked to the Event.
Multiplicity is 0+, access is read/write.
A collection of IO Flows for which the Event is used as the IO Item.
Multiplicity is 0+, access is read/write.
Operation
A relationship to the Operation that triggers the Event.
The Operation association applies only when the Event Type is set to 0, that is, Call Event.
Multiplicity is 0-1, access is read/write.
Relationship to Comments that are owned by the Event.
Multiplicity is 0+, access is read/write.
Relationship to Constraints that are owned by the Event.
Multiplicity is 0+, access is read/write.
A collection of Parameters associated with one Event.
Multiplicity is 0+, access is read/write.
Signal
A relationship to the Signal that triggers the Event.
The Signal association applies only when the Event Type is set to 3, that is, Signal Event.
Multiplicity is 0-1, access is read/write.