Difference between revisions of "Extensions.EventHandling.IsTimerExpiredEvent"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''IsTimerExpiredEvent '''}}[[Category:EventHandling]] | {{DISPLAYTITLE: '''IsTimerExpiredEvent '''}}[[Category:EventHandling]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | IsTimerExpiredEvent | Checks whether an event comes '''TimerExpiredEventSource''' | [[Term]] | [[Extensions.EventHandling|OTX EventHandling extension]] | [[Event source property related terms]] | - | - }} | + | {{ClassificationActivity | IsTimerExpiredEvent | Checks whether an event comes '''TimerExpiredEventSource''' | [[Term]] | [[Extensions.EventHandling|OTX EventHandling extension]] | [[Extensions.EventHandling#Terms|Event source property related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | The OTX '''IsTimerExpiredEvent''' term | + | The OTX '''IsTimerExpiredEvent''' term accepts an EventTerm term yielding an Event object that has been raised by the OTX runtime, as a result of using a '''TimerExpiredEventSource''' in a [[Extensions.EventHandling.WaitForEvent|WaitForEvent]] action. The term shall return TRUE if and only if the Event originates from a '''TimerExpiredEventSource'''. |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns TRUE if the event comes from a '''TimerExpiredEventSource'''.}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns TRUE if the event comes from a '''TimerExpiredEventSource'''.}} | ||
Revision as of 08:59, 26 September 2018
Contents
Classification
| Name | IsTimerExpiredEvent |
| Short Description | Checks whether an event comes TimerExpiredEventSource |
| Class | Term |
| Extension | OTX EventHandling extension |
| Group | Event source property related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
BooleanTerm = EventHandling.IsTimerExpiredEvent(EventTerm);Description
The OTX IsTimerExpiredEvent term accepts an EventTerm term yielding an Event object that has been raised by the OTX runtime, as a result of using a TimerExpiredEventSource in a WaitForEvent action. The term shall return TRUE if and only if the Event originates from a TimerExpiredEventSource.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Boolean | Returns TRUE if the event comes from a TimerExpiredEventSource. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Event | Event | Term | - | [1] | The event, whose type is checked. |
OTL Examples
EventHandling.EventSource EventSource1;
EventHandling.Event Event1;
Boolean Boolean1 = false;
EventSource1 = EventHandling.TimerExpiredEventSource(100);
EventHandling.WaitForEvent({EventSource1}, Event1);
Boolean1 = EventHandling.IsTimerExpiredEvent(Event1);