Extensions.BusMonitoring.GetBusFrameTimestamp

Classification

Name	GetBusFrameTimestamp
Short Description	Accepts an BusFrame and returns an otx:Integer that represents the frame time stamp in nano seconds
Class	Term
Extension	OTX BusMonitoring extension
Group	BusMonitoring related Terms
Exceptions	NotSupportedException
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

IntegerTerm BusMonitoring.GetBusFrameTimestamp(BusFrameTerm frame);

Description

The GetBusFrameTimestamp term accepts an BusFrame and returns an otx:Integer that represents the frame time stamp in nano seconds.

The timestamp is only useful for putting messages into chronological relation to each other.

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:Integer	Represents the frame time stamp in nano seconds

Properties

Name	Data Type	Class	Default	Cardinality	Description
frame	BusFrame	Term	-	[1..1]	Represents the BusFrame to get the timestamp from.

OTL Examples

/// Local Declarations

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

/// Flow

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

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

BusMonitoring.StopBusMonitoring(BusMonitor1);

See also

StartBusMonitoring
StopBusMonitoring
BusMonitorEventSource
FetchBusMonitorBusFrames
GetBusFrameAddress
GetBusFrameAsString
GetBusFrameData
GetBusFrameType
IsBusMonitorEvent