Difference between revisions of "Extensions.EventHandling.IsThresholdExceededEvent"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
{{DISPLAYTITLE:  '''IsTresholdExceededEvent'''}}[[Category:EventHandling]]
+
{{DISPLAYTITLE:  '''IsThresholdExceededEvent'''}}[[Category:EventHandling]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | IsTresholdExceededEvent | Checks whether an event comes '''ThresholdExceededEventSource''' | [[Term]] | [[Extensions.EventHandling|OTX EventHandling extension]] | [[Event source property related terms]] | - | - }}
+
{{ClassificationActivity | IsThresholdExceededEvent | Checks whether an event comes '''ThresholdExceededEventSource''' | [[Term]] | [[Extensions.EventHandling|OTX EventHandling extension]] | [[Event source property related terms]] | - | - }}
  
 
== OTL  Syntax ==
 
== OTL  Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
BooleanTerm = EventHandling.IsTresholdExceededEvent(EventTerm);
+
BooleanTerm = EventHandling.IsThresholdExceededEvent(EventTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
The OTX '''IsTresholdExceededEvent''' term is  TRUE back when the event if and only from '''ThresholdExceededEventSource''' comes.  
+
The OTX '''IsThresholdExceededEvent''' term is  TRUE back when the event if and only from '''ThresholdExceededEventSource''' comes.  
  
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns TRUE if the event comes from a '''ThresholdExceededEventSource'''.}}
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns TRUE if the event comes from a '''ThresholdExceededEventSource'''.}}

Revision as of 06:52, 12 December 2016

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

BooleanTerm = EventHandling.IsThresholdExceededEvent(EventTerm);

Description

The OTX IsThresholdExceededEvent term is TRUE back when the event if and only from ThresholdExceededEventSource comes.

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

Properties

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

OTL Examples

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

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

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

		terminate;
	}
}

Boolean1 = EventHandling.IsThresholdExceededEvent(Event1);

See also

IsMonitorChangeEvent
IsTimerExpiredEvent
GetNewValue