Difference between revisions of "Extensions.EventHandling.TimerExpiredEventSource"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''TimerExpiredEventSource'''}}[[Category:EventHandling]] | {{DISPLAYTITLE: '''TimerExpiredEventSource'''}}[[Category:EventHandling]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | TimerExpiredEventSource | Create an event source for timing | [[Term]] | [[Extensions.EventHandling|OTX EventHandling extension]] | [[Event source related terms]] | [[Core. | + | {{ClassificationActivity | TimerExpiredEventSource | Create an event source for timing | [[Term]] | [[Extensions.EventHandling|OTX EventHandling extension]] | [[Extensions.EventHandling#Terms|Event source related terms]] | [[Core.DataTypes.ComplexDataType.OutOfBoundsException|OutOfBoundsException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | EventSourceTerm = EventHandling.TimerExpiredEventSource( | + | EventSourceTerm = EventHandling.TimerExpiredEventSource(NumericTerm); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The OTX '''TimerExpiredEventSource''' term | + | The OTX '''TimerExpiredEventSource''' term shall create an event source that produces an event when a specified time expires. If the specified time expires, the timer expiry event is produced and put into the event source's queue. Event queueing shall start immediately once the event source is created. |
{{TermReturnValue| [[Extensions.EventHandling.EventSource|EventSource]] | '''The EventSource''', the timing monitors.}} | {{TermReturnValue| [[Extensions.EventHandling.EventSource|EventSource]] | '''The EventSource''', the timing monitors.}} | ||
| Line 16: | Line 16: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| TimeOut | [[ | + | {{TableRowPropertie1| TimeOut | [[Numeric]] | [[Term]] | - | [1] | This element specifies an [[Core.DataTypes.SimpleDataType.Integer|Integer]] value that is interpreted as a time in milli-seconds to wait. [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated.}} |
|} | |} | ||
Revision as of 08:40, 26 September 2018
Contents
Classification
| Name | TimerExpiredEventSource |
| Short Description | Create an event source for timing |
| Class | Term |
| Extension | OTX EventHandling extension |
| Group | Event source related terms |
| Exceptions | OutOfBoundsException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
EventSourceTerm = EventHandling.TimerExpiredEventSource(NumericTerm);Description
The OTX TimerExpiredEventSource term shall create an event source that produces an event when a specified time expires. If the specified time expires, the timer expiry event is produced and put into the event source's queue. Event queueing shall start immediately once the event source is created.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| EventSource | The EventSource, the timing monitors. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| TimeOut | Numeric | Term | - | [1] | This element specifies an Integer value that is interpreted as a time in milli-seconds to wait. Float values shall be truncated. |
OTL Examples
EventHandling.EventSource EventSource1;
Integer Variable1;
EventHandling.Event Event1;
EventSource1 = EventHandling.TimerExpiredEventSource(1000);
parallel
{
lane
{
while (true) : Loop0
{
Variable1 = Variable1 + 1;
}
}
lane
{
EventHandling.WaitForEvent({EventSource1}, Event1);
terminate;
}
}