Extensions.EventHandling.IsTimerExpiredEvent

From emotive
Jump to navigation Jump to search

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.

Icons Note.png 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);

See also

IsMonitorChangeEvent
IsThresholdExceededEvent
GetNewValue