Extensions.DiagCom.DiagServiceEventSource

From emotive
Jump to navigation Jump to search

Classification

Name DiagServiceEventSource
Short Description Binds a diagnosis service to an event handling source
Class Term
Extension OTX DiagCom extension
Group Event related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

EventSourceTerm DiagCom.DiagServiceEventSource(DiagServiceTerm diagService);

Description

The DiagServiceEventSource term accepts a DiagService object that is to be made an event source. A DiagService will trigger an event every time a new Result has arrived.The DiagServiceEventSource term is the complementary functionality to the asynchronous execution feature of the ExecuteDiagService action: when ExecuteDiagService is used with <executeAsync> set to true, the only way to be notified of available results for the executed diagnostic service is to use it as an event source through the DiagServiceEventSource term.

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 Source for event handling

Properties

Name Data Type Class Default Cardinality Description
DiagService DiagService Term - [1] Represents the DiagService that will be connected to the event source.

OTL Examples

/// Local Declarations

DiagCom.DiagService DiagService1;
EventHandling.EventSource EventSource1;
DiagCom.ComChannel ComChannel1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_DiagnSessiContr");
EventSource1 = DiagCom.DiagServiceEventSource(DiagService1);

See also

GetComChannel
CreateDiagServiceByName
ExecuteDiagService
WaitForEvent
GetDiagServiceFromEvent
IsDiagServiceEvent