Difference between revisions of "Extensions.EventPlus.IsDeepMonitorChangeEvent"
Jump to navigation
Jump to search
(Created page with "{{DISPLAYTITLE: '''IsDeepMonitorChangeEvent'''}}Category:EventPlus == Classification == {{ClassificationActivity | IsDeepMonitorChangeEvent | UPDATING...<!--Create an eve...") |
|||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''IsDeepMonitorChangeEvent'''}}[[Category:EventPlus]] | {{DISPLAYTITLE: '''IsDeepMonitorChangeEvent'''}}[[Category:EventPlus]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | IsDeepMonitorChangeEvent | | + | {{ClassificationActivity | IsDeepMonitorChangeEvent | Checks whether the event source is a DeepMonitorChangeEvent or not.| [[Term]] | [[Extensions.EventPlus|OTX EventPlus extension]] | [[Extensions.EventPlus#Terms|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 = EventPlus.IsDeepMonitorChangeEvent(EventTerm, Variable); | |
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
== Description == | == 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 [[Extensions.EventPlus.DeepMonitorChangeEventSource|DeepMonitorChangeEventSource]] in a [[Extensions.EventHandling.WaitForEvent|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. | |
| − | The OTX ''' | ||
| − | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | if the event of a '''DeepMonitorChangeEventSource'''.}} | |
| − | |||
| − | {{TermReturnValue| [[ | ||
== Properties == | == Properties == | ||
| − | |||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Variable | - | [[Variable]] | - | [1] | | + | {{TableRowPropertie1| event| [[Extensions.EventHandling.Event|Event]] | [[Term]] | - | [1..1] | Represents the Event whose type shall be tested.}} |
| + | {{TableRowPropertie2| Variable | - | [[Variable]] | - | [0..1] | Optionally specifies the variable which shall be tested for being the reason for | ||
| + | the event.}} | ||
|} | |} | ||
| − | + | ||
== OTL Examples == | == OTL Examples == | ||
| − | |||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | |||
EventHandling.EventSource EventSource1; | EventHandling.EventSource EventSource1; | ||
EventHandling.Event Event1; | EventHandling.Event Event1; | ||
| + | ByteField ByteField1 = &012345; | ||
| + | Boolean Boolean1; | ||
| + | |||
| + | /// Flow | ||
| + | |||
| + | EventSource1 = EventPlus.DeepMonitorChangeEventSource(ByteField1); | ||
| − | |||
parallel | parallel | ||
{ | { | ||
| − | + | lane | |
| − | + | { | |
| − | + | ShiftRight(ByteField1, 2); | |
| − | + | } | |
| − | + | lane | |
| − | + | { | |
| − | + | EventHandling.WaitForEvent({EventSource1}, Event1); | |
| − | + | Boolean1 = EventPlus.IsDeepMonitorChangeEvent(Event1, ByteField1); | |
| + | } | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | ||
== See also == | == See also == | ||
[[Extensions.EventPlus.DeepMonitorChangeEventSource|DeepMonitorChangeEventSource]] <br/> | [[Extensions.EventPlus.DeepMonitorChangeEventSource|DeepMonitorChangeEventSource]] <br/> | ||
<!--[[Extensions.EventPlus.IsDeepMonitorChangeEvent|IsDeepMonitorChangeEvent]] <br/>--> | <!--[[Extensions.EventPlus.IsDeepMonitorChangeEvent|IsDeepMonitorChangeEvent]] <br/>--> | ||
Revision as of 11:05, 26 September 2018
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, 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
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);
}
}
