Extensions.EventHandling.TimerExpiredEventSource

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.

if the timeout value is negative, the OutOfBoundsException exception will be thrown.

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;
   }
}

See also

ThresholdExceededEventSource
WaitForEvent