Extensions.BusMonitoring.GetBusFrameType
Jump to navigation
Jump to search
Contents
Classification
Name | GetBusFrameType |
Short Description | Accepts an BusFrame and returns an otx:String that represents the frame type |
Class | Term |
Extension | OTX BusMonitoring extension |
Group | BusMonitoring related Terms |
Exceptions | NotSupportedException |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
StringTerm BusMonitoring.GetBusFrameType(BusFrameTerm frame);
Description
The GetBusFrameType term accepts an BusFrame and returns an otx:String that represents the frame type (examples for CAN-specific message types are "RX", "TX", "ES", "EF", "EA" and "EC"). If the type cannot be obtained an empty string will be returned.
Important: The returned string shall be formatted as the type string of a message given in ISO 22900 Annex F. |
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:String | Represents the frame type |
Properties
Name | Data Type | Class | Default | Cardinality | Description |
frame | BusFrame | Term | - | [1..1] | Represents the BusFrame to get the type from. |
OTL Examples
/// Local Declarations
BusMonitoring.BusMonitor BusMonitor1;
List<BusMonitor.BusFrame> List1;
Integer Integer1;
String String1;
/// Flow
BusMonitoring.StartBusMonitoring(BusMonitor1);
List2 = BusMonitoring.FetchBusMonitorBusFrames(BusMonitor1);
foreach (Integer1 in List1) : ForEachLoop1
{
String1 = BusMonitoring.GetBusFrameType(List1[Integer1]);
}
BusMonitoring.StopBusMonitoring(BusMonitor1);
See also
StartBusMonitoring
StopBusMonitoring
BusMonitorEventSource
FetchBusMonitorBusFrames
GetBusFrameAddress
GetBusFrameAsString
GetBusFrameData
GetBusFrameTimestamp
IsBusMonitorEvent