Extensions.BusMonitoring.IsBusMonitorEvent
Jump to navigation
Jump to search
Contents
Classification
Name | IsBusMonitorEvent |
Short Description | Accepts an EventValue term yielding an Event object that has been raised by the OTX runtime |
Class | Term |
Extension | OTX BusMonitoring extension |
Group | BusMonitoring related Terms |
Exceptions | |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
BooleanTerm BusMonitor.IsBusMonitorEvent(EventValue event, BusMonitorVariable monitor);
Description
The IsBusMonitorEvent term accepts an EventValue term yielding an Event object that has been raised by the OTX runtime. The term will return true if and only if the Event originates from a BusMonitorEventSource term. In case an optional BusMonitorVariable is specified, the term will return true if and only if the Event was fired because that particular BusMonitor fired the event.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
Data Type | Description |
otx:Boolean | True if and only if the Event originates from a BusMonitorEventSource term or the Event was fired because that particular BusMonitor fired the even |
Properties
Name | Data Type | Class | Default | Cardinality | Description |
event | Event | Value | - | [1..1] | Represents the Event whose type will be tested. |
monitor | BusMonitor | Variable | - | [0..1] | Optionally specifies the particular BusMonitor which fired the event. |
OTL Examples
/// Local Declarations
BusMonitoring.BusMonitor BusMonitor1;
List<BusMonitor.BusFrame> List1;
Integer Integer1;
String String1;
/// Flow
BusMonitoring.StartBusMonitoring(BusMonitor1);
List2 = BusMonitoring.FetchBusMonitorBusFrames(BusMonitor1);
EventSource1 = BusMonitoring.BusMonitorEventSource(BusMonitor1);
EventHandling.WaitForEvent({EventSource1}, Event1);
List2 = BusMonitoring.FetchBusMonitorBusFrames(BusMonitor1);
Boolean1 = BusMonitoring.IsBusMonitorEvent(Event1);
BusMonitoring.StopBusMonitoring(BusMonitor1);
See also
StartBusMonitoring
StopBusMonitoring
BusMonitorEventSource
FetchBusMonitorBusFrames
GetBusFrameAddress
GetBusFrameAsString
GetBusFrameData
GetBusFrameTimestamp
GetBusFrameType