Extensions.BusMonitoring.BusMonitorEventSource

From emotive
Jump to navigation Jump to search

Classification

Name BusMonitorEventSource
Short Description Accepts a BusMonitor object that is to be made an event source
Class Term
Extension OTX BusMonitoring extension
Group BusMonitoring related Terms
Exceptions TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

EventSourceTerm BusMonitoring.BusMonitorEventSource(BusMonitorVariable monitor, IntegerTerm numberOfFrames);

Description

The BusMonitorEventSource term accepts a BusMonitor object that is to be made an event source. This term enables an OTX sequence to use a BusMonitor as a source for events in the context of the OTX EventHandling extension. A BusMonitor will trigger an event every time the number of frames in the buffer reaches the number in the numberOfFrames property.

Icons Note.png The related MVCI system operations are

MCDMonitoringLink::setNoOfSampleToFireEvent and
MCDEventHandler::onMonitoringFramesReady

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
EventSource

Properties

Name Data Type Class Default Cardinality Description
monitor BusMonitor Variable - [1..1] Represents the BusMonitorVariable which can cause the event.
numberOfFrames Integer Term 1 [0..1] Represents a number of frames which have to be collected in the buffer to fire an event. If the internal buffer is less than the number of frames, the event is fired, when the buffer is filled. Default value is 1.

OTL Examples

/// Local Declarations

BusMonitoring.BusMonitor BusMonitor1;
EventHandling.EventSource EventSource1;

/// Flow

BusMonitoring.StartBusMonitoring(BusMonitor1);
EventSource1 = BusMonitoring.BusMonitorEventSource(BusMonitor1);
BusMonitoring.StopBusMonitoring(BusMonitor1);

See also

StartBusMonitoring
StopBusMonitoring
FetchBusMonitorBusFrames
GetBusFrameAddress
GetBusFrameAsString
GetBusFrameData
GetBusFrameTimestamp
GetBusFrameType
IsBusMonitorEvent