Difference between revisions of "Extensions.EventHandling.IsMonitorChangeEvent"
Jump to navigation
Jump to search
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''IsMonitorChangeEvent'''}}[[Category:EventHandling]] | {{DISPLAYTITLE: '''IsMonitorChangeEvent'''}}[[Category:EventHandling]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | IsMonitorChangeEvent | Checks whether an event monitor change event source or '''ThresholdExceededEventSource''' comes | [[Term]] | [[Extensions.EventHandling|OTX EventHandling extension]] | [[Event source property related terms]] | - | [[Extensions.EventHandling.EventChk002|Event_Chk002]] }} | + | {{ClassificationActivity | IsMonitorChangeEvent | Checks whether an event monitor change event source or '''ThresholdExceededEventSource''' comes | [[Term]] | [[Extensions.EventHandling|OTX EventHandling extension]] | [[Extensions.EventHandling#Terms|Event source property related terms]] | - | [[Extensions.EventHandling.EventChk002|Event_Chk002]] }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | BooleanTerm | + | BooleanTerm EventHandling.IsMonitorChangeEvent(EventTerm event, Variable variable); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The OTX '''IsMonitorChangeEvent''' term | + | The OTX '''IsMonitorChangeEvent''' term accepts an EventTerm yielding an Event object that has been raised by the OTX runtime system, as a result of either using a '''MonitorChangeEventSource''' or a '''ThresholdExceededEventSource''' in a [[Extensions.EventHandling.WaitForEvent|WaitForEvent]] action. The term will return TRUE if and only if the Event originates from such a kind of event source. In case an optional Variable is specified, the term will return true if and only if the Event was fired because that particular Variable changed. If the given Variable was not the reason for the event, FALSE will be returned. |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns TRUE if the event of a '''MonitorChangeEventSource''' or '''ThresholdExceededEventSource''' comes.}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns TRUE if the event of a '''MonitorChangeEventSource''' or '''ThresholdExceededEventSource''' comes.}} | ||
| Line 22: | Line 22: | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
EventHandling.EventSource EventSource1; | EventHandling.EventSource EventSource1; | ||
String Variable1; | String Variable1; | ||
EventHandling.Event Event1; | EventHandling.Event Event1; | ||
Boolean Result1 = false; | Boolean Result1 = false; | ||
| + | |||
| + | /// Flow | ||
EventSource1 = EventHandling.MonitorChangeEventSource(Variable1); | EventSource1 = EventHandling.MonitorChangeEventSource(Variable1); | ||
| Line 37: | Line 41: | ||
lane | lane | ||
{ | { | ||
| − | + | EventHandling.WaitForEvent({EventSource1}, Event1); | |
} | } | ||
} | } | ||
| − | Result1 = EventHandling.IsMonitorChangeEvent(Event1 | + | Result1 = EventHandling.IsMonitorChangeEvent(Event1); |
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 10:40, 12 September 2019
Contents
Classification
| Name | IsMonitorChangeEvent |
| Short Description | Checks whether an event monitor change event source or ThresholdExceededEventSource comes |
| Class | Term |
| Extension | OTX EventHandling extension |
| Group | Event source property related terms |
| Exceptions | - |
| Checker Rules | Event_Chk002 |
| Standard Compliant | Yes |
OTL Syntax
BooleanTerm EventHandling.IsMonitorChangeEvent(EventTerm event, Variable variable);Description
The OTX IsMonitorChangeEvent term accepts an EventTerm yielding an Event object that has been raised by the OTX runtime system, as a result of either using a MonitorChangeEventSource or a ThresholdExceededEventSource in a WaitForEvent action. The term will return TRUE if and only if the Event originates from such a kind of event source. In case an optional Variable is specified, the term will return true if and only if the Event was fired because that particular Variable changed. If the given Variable was not the reason for the event, FALSE will be returned.
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 of a MonitorChangeEventSource or ThresholdExceededEventSource comes. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Event | Event | Term | - | [1] | The event, whose type is checked. |
| Variable | - | Variable | - | [0..1] | It is checked if the optional variable is the reason for the event. |
OTL Examples
/// Local Declarations
EventHandling.EventSource EventSource1;
String Variable1;
EventHandling.Event Event1;
Boolean Result1 = false;
/// Flow
EventSource1 = EventHandling.MonitorChangeEventSource(Variable1);
parallel
{
lane
{
Variable1 = "String changed";
}
lane
{
EventHandling.WaitForEvent({EventSource1}, Event1);
}
}
Result1 = EventHandling.IsMonitorChangeEvent(Event1);