Extensions.EventHandling.IsThresholdExceededEvent

Classification

Name	IsThresholdExceededEvent
Short Description	Checks whether an event comes ThresholdExceededEventSource
Class	Term
Extension	OTX EventHandling extension
Group	Event source property related terms
Exceptions	-
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

/// Local Declarations
Boolean BooleanVariable = false;
/// Flow
BooleanVariable = EventHandling.IsThresholdExceededEvent(EventTerm);

Description

The OTX IsThresholdExceededEvent term accepts an EventTerm yielding an Event object that has been raised by the OTX runtime, as a result of using a ThresholdExceededEventSource in a WaitForEvent action. The term shall return TRUE if and only if the Event originates from a ThresholdExceededEventSource.

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 ThresholdExceededEventSource.

Properties

Name	Data Type	Class	Default	Cardinality	Description
Event	Event	Term	-	[1]	The event, whose type is checked.

OTL Examples

/// Local Declarations

Float LowerThreshold1 = 0;
Float UpperThreshold1 = 1;
EventHandling.EventSource EventSource1;
Float Variable1 = 0;
EventHandling.Event Event1;
Boolean Boolean1 = false;

/// Flow

EventSource1 = EventHandling.ThresholdExceededEventSource(LowerThreshold1, UpperThreshold1, Variable1);

parallel
{
	lane
	{
		while (true) : WhileLoop1
		{
			Variable1 = (Variable1 + 0.001);
		}
	}
	lane
	{
		EventHandling.WaitForEvent({EventSource1}, Event1);

		terminateLanes;
	}
}

Boolean1 = EventHandling.IsThresholdExceededEvent(Event1);

See also

IsMonitorChangeEvent
IsTimerExpiredEvent
GetNewValue