Extensions.BusMonitoring.StartBusMonitoring

Classification

Name	StartBusMonitoring
Short Description	Starts the monitoring and optional tracing on a physical link
Class	Action
Extension	OTX BusMonitoring extension
Group	BusMonitoring related Actions
Exceptions	NotSupportedException
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

ActionRealisation BusMonitoring.StartBusMonitoring(BusMonitorVariable monitor, ComInterfaceTerm comInterface, StringTerm interfaceResource, ListTerm addresses, BusMonitorModeTerm mode, StringTerm target);

Description

Starts the monitoring and optional tracing on a physical link. Use FetchBusMonitorBusFrames to retrieve frames on a BusMonitor.

The related MVCI system methods are MCDProject::createMonitoringLink(MCDInterfaceResource mCDInterfaceResource); MCDMonitorLink::getMessageFilters(); MCDMessageFilters::addByFilterType(int messageFilterType); MCDMessageFilter::enableMessageFilter(true); MCDMonitoringLink::start();

Properties

Name	Data Type	Class	Default	Cardinality	Description
monitor	BusMonitor	Variable	-	[1..1]	This element represents the variable that refers to the handle for the monitor started by this action. This will be used later to fetch the frames of the monitor (FetchBusMonitorBusFrames) or stop the monitor explicitly (StopBusMonitoring).
comInterface	ComInterface	Term	-	[0..1]	Represents a handle for the communication interface on which the monitoring will be started. If no comIf:ComInterface is given the default communication interface will be used (the interface that is needed for diag:GetComChannel, see ComInterface extension).
interfaceResource	String	Term	-	[0..1]	Represents the name of the physical link, e.g. "CAN1". If no interface resource is given the default interface resource will be used (interface that is needed for diag:GetComChannel, see ComInterface extension)
addresses	List<Integer>	Term	-	[0..1]	Represents an optional list of integer numbers, defining the addresses to be monitored (e.g. on a CAN bus the CAN IDs of signals or ECUs). If no list or an empty list is given all data will be monitored. In case a MVCI system is used pass filters are applied to CAN ID filtering.
mode	BusMonitorMode	Term	-	[0..1]	Represents an optional mode to specify how the monitored frames will be processed, see BusMonitorModes.
target	String	Term	-	[0..1]	This optional element will be used for locating the resource to which the trace will be written. The target will be defined by a URI. Other resource-location mechanisms may also be used.

OTL Examples

/// Local Declarations

BusMonitoring.BusMonitor BusMonitor1;

/// Flow

BusMonitoring.StartBusMonitoring(BusMonitor1);

See also

StopBusMonitoring
BusMonitorEventSource
FetchBusMonitorBusFrames
GetBusFrameAddress
GetBusFrameAsString
GetBusFrameData
GetBusFrameTimestamp
GetBusFrameType
IsBusMonitorEvent