Extensions.EventPlus.IsDeepMonitorChangeEvent
Jump to navigation
Jump to search
Contents
Classification
Name | IsDeepMonitorChangeEvent |
Short Description | Checks whether the event source is a DeepMonitorChangeEvent or not. |
Class | Term |
Extension | OTX EventPlus extension |
Group | Event source property related terms |
Exceptions | - |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
BooleanTerm EventPlus.IsDeepMonitorChangeEvent(EventTerm event, Variable variable);
Description
The OTX IsDeepMonitorChangeEvent term accepts an EventTerm yielding an Event object that has been raised by the OTX runtime system, as a result of using a DeepMonitorChangeEventSource in a WaitForEvent action. The term shall 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 shall 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 shall 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 | if the event of a DeepMonitorChangeEventSource. |
Properties
Name | Data Type | Class | Default | Cardinality | Description |
Event | Event | Term | - | [1..1] | Represents the Event whose type shall be tested. |
Variable | - | Variable | - | [0..1] | Optionally specifies the variable which shall be tested for being the reason for the event. |
OTL Examples
/// Local Declarations
EventHandling.EventSource EventSource1;
EventHandling.Event Event1;
ByteField ByteField1 = &012345;
Boolean Boolean1;
/// Flow
EventSource1 = EventPlus.DeepMonitorChangeEventSource(ByteField1);
parallel
{
lane
{
ShiftRight(ByteField1, 2);
}
lane
{
EventHandling.WaitForEvent({EventSource1}, Event1);
Boolean1 = EventPlus.IsDeepMonitorChangeEvent(Event1, ByteField1);
}
}