Extensions.BusMonitoring.FetchBusMonitorBusFrames
Jump to navigation
Jump to search
Contents
Classification
| Name | FetchBusMonitorBusFrames |
| Short Description | Accepts a BusMonitor and returns a list of BusFrame |
| Class | Term |
| Extension | OTX BusMonitoring extension |
| Group | BusMonitoring related Terms |
| Exceptions | |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
ListTerm BusMonitoring.FetchBusMonitorBusFrames(BusMonitorTerm monitor);
Description
The FetchBusMonitorBusFrames term accepts a BusMonitor and returns a list of BusFrame. All available frames will be returned and removed from buffer.
The related MVCI system method is MCDMonitorLink::fetchMonitoringFrames(0)
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| List<BusMonitor.BusFrame> |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| monitor | BusMonitor | Term | - | [1..1] | Represents a BusMonitor to get the frames from. |
OTL Examples
/// Local Declarations
BusMonitoring.BusMonitor BusMonitor1;
List<BusMonitor.BusFrame> List1;
/// Flow
BusMonitoring.StartBusMonitoring(BusMonitor1);
List1 = BusMonitoring.FetchBusMonitorBusFrames(BusMonitor1);
BusMonitoring.StopBusMonitoring(BusMonitor1);
See also
StartBusMonitoring
StopBusMonitoring
BusMonitorEventSource
GetBusFrameAddress
GetBusFrameAsString
GetBusFrameData
GetBusFrameTimestamp
GetBusFrameType
IsBusMonitorEvent
