Difference between revisions of "Extensions.EventHandling.IsTimerExpiredEvent"
Jump to navigation
Jump to search
(Created page with "Category:EventHandling == Classification == {{ClassificationActivity | IsTimerExpiredEvent | Checks whether an event comes '''TimerExpiredEventSource''' | Term | Eve...") |
|||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:EventHandling]] | + | {{DISPLAYTITLE: '''IsTimerExpiredEvent '''}}[[Category:EventHandling]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | IsTimerExpiredEvent | Checks whether an event comes '''TimerExpiredEventSource''' | [[Term]] | [[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 == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | BooleanTerm EventHandling.IsTimerExpiredEvent(EventTerm event); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== 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| [[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'''.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Event | [[Extensions.EventHandling.Event|Event]] | [[Term]] | - | [1] | The event, whose type is checked.}} |
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Boolean | + | /// Local Declarations |
| + | |||
| + | EventHandling.EventSource EventSource1; | ||
| + | EventHandling.Event Event1; | ||
| + | Boolean Boolean1 = false; | ||
| + | |||
| + | /// Flow | ||
| + | |||
| + | |||
| + | EventSource1 = EventHandling.TimerExpiredEventSource(100); | ||
| + | EventHandling.WaitForEvent({EventSource1}, Event1); | ||
| + | Boolean1 = EventHandling.IsTimerExpiredEvent(Event1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[ | + | [[Extensions.EventHandling.IsMonitorChangeEvent|IsMonitorChangeEvent]] <br/> |
| − | [[ | + | [[Extensions.EventHandling.IsThresholdExceededEvent|IsThresholdExceededEvent]] <br/> |
| − | [[GetNewValue]] | + | [[Extensions.EventHandling.GetNewValue|GetNewValue]] |
Latest revision as of 09:35, 2 November 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 event);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
/// Local Declarations
EventHandling.EventSource EventSource1;
EventHandling.Event Event1;
Boolean Boolean1 = false;
/// Flow
EventSource1 = EventHandling.TimerExpiredEventSource(100);
EventHandling.WaitForEvent({EventSource1}, Event1);
Boolean1 = EventHandling.IsTimerExpiredEvent(Event1);