Extensions.BusMonitoring.GetBusFrameData

From emotive
Jump to navigation Jump to search

Classification

Name GetBusFrameData
Short Description Accepts an BusFrame and returns an otx:ByteField that represents the frame communication data
Class Term
Extension OTX BusMonitoring extension
Group BusMonitoring related Terms
Exceptions NotSupportedException
Checker Rules -
Standard Compliant Yes

OTL Syntax

ByteFieldTerm BusMonitoring.GetBusFrameData(BusFrameTerm frame);

Description

The GetBusFrameData term accepts an BusFrame and returns an otx:ByteField that represents the frame communication data.

Exclamation.png Important: The returned ByteField wiil be formatted as the data string of a message given in ISO 22900 Annex F.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
otx:ByteField Represents the frame communication data.

Properties

Name Data Type Class Default Cardinality Description
frame BusFrame Term - [1..1] Represents the BusFrame to get the the data from. E.g. because the frame data is not formatted as it is given in ISO 22900 Annex F.

OTL Examples

/// Local Declarations

BusMonitoring.BusMonitor BusMonitor1;
List<BusMonitor.BusFrame> List1;
Integer Integer1;
ByteField ByteField1;

/// Flow

BusMonitoring.StartBusMonitoring(BusMonitor1);
List2 = BusMonitoring.FetchBusMonitorBusFrames(BusMonitor1);

foreach (Integer1 in List1) : ForEachLoop1
{
	ByteField1 = BusMonitoring.GetBusFrameData(List1[Integer1]);
}

BusMonitoring.StopBusMonitoring(BusMonitor1);

See also

StartBusMonitoring
StopBusMonitoring
BusMonitorEventSource
FetchBusMonitorBusFrames
GetBusFrameAddress
GetBusFrameAsString
GetBusFrameTimestamp
GetBusFrameType
IsBusMonitorEvent