OpenTestSystem.Otx.Extensions.BusMonitoring.Actions.StartBusMonitoring Class Reference

Starts the monitoring More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.BusMonitoring.Actions.StartBusMonitoring:

Public Attributes
ListTerm	addresses
	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 shall be monitored. More...
ComInterfaceTerm	comInterface
	Represents a handle for the communication interface on which the monitoring should be started. If no comIf:ComInterface is given the default communication interface shall be used. More...
StringTerm	interfaceResource
	Represents the name of the physical link, e.g. "CAN1". If no interface resource is given the default interface resource shall be used. More...
BusMonitorModeTerm	mode
	Represents an optional mode to specify how the monitored frames shall be processed, see BusMonitorModes. More...
BusMonitorVariable	monitor
	This element represents the variable that refers to the handle for the monitor started by this action. This can be used later to fetch the frames of the monitor (FetchBusMonitorBusFrames) or stop the monitor explicitly (StopBusMonitoring). More...
StringTerm	target
	This optional element shall be used for locating the resource to which the trace shall be written. The target should be defined by a URI. Other resource-location mechanisms may also be used. More...
Public Attributes inherited from OpenTestSystem.Otx.Core.Actions.ActionRealisation
OtxLink	validFor
	Validity of ActionRealisation. More...

Detailed Description

Starts the monitoring

The StartBusMonitoring activity starts the monitoring and optional tracing on a physical link. Use FetchBusMonitorBusFrames to retrieve frames on a BusMonitor.

Note

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

Exceptions

Exceptions.NotSupportedException

In case a system without any addresses (e.g. DoIP or K-Line) is used and addresses are supplied by the addresses property, a NotSupportedException shall be thrown.

Checker rules

CheckerRule.BusMonitoring_Chk001 - correct element types for adresses list in StartBusMonitoring

Syntax

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

Examples

// Local Declarations
BusMonitoring.BusMonitor BusMonitor1;
 
// Flow
BusMonitoring.StartBusMonitoring(BusMonitor1);

Member Data Documentation

addresses

ListTerm OpenTestSystem.Otx.Extensions.BusMonitoring.Actions.StartBusMonitoring.addresses

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 shall be monitored.

Note

In case a MVCI system is used pass filters are applied to CAN ID filtering.

comInterface

ComInterfaceTerm OpenTestSystem.Otx.Extensions.BusMonitoring.Actions.StartBusMonitoring.comInterface

Represents a handle for the communication interface on which the monitoring should be started. If no comIf:ComInterface is given the default communication interface shall be used.

interfaceResource

StringTerm OpenTestSystem.Otx.Extensions.BusMonitoring.Actions.StartBusMonitoring.interfaceResource

Represents the name of the physical link, e.g. "CAN1". If no interface resource is given the default interface resource shall be used.

mode

BusMonitorModeTerm OpenTestSystem.Otx.Extensions.BusMonitoring.Actions.StartBusMonitoring.mode

Represents an optional mode to specify how the monitored frames shall be processed, see BusMonitorModes.

monitor

BusMonitorVariable OpenTestSystem.Otx.Extensions.BusMonitoring.Actions.StartBusMonitoring.monitor

This element represents the variable that refers to the handle for the monitor started by this action. This can be used later to fetch the frames of the monitor (FetchBusMonitorBusFrames) or stop the monitor explicitly (StopBusMonitoring).

target

StringTerm OpenTestSystem.Otx.Extensions.BusMonitoring.Actions.StartBusMonitoring.target

This optional element shall be used for locating the resource to which the trace shall be written. The target should be defined by a URI. Other resource-location mechanisms may also be used.