Extensions.DiagCom.IsDiagServiceEvent

From emotive
Jump to navigation Jump to search

Classification

Name IsDiagServiceEvent
Short Description Checks the type of the Event
Class Term
Extension OTX DiagCom extension
Group Event related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

BooleanTerm DiagCom.IsDiagServiceEvent(EventValue event);

Description

The IsDiagServiceEvent term accepts an EventValue term yielding an Event object that has been raised by the OTX runtime, as a result of declaring a DiagService object as an event source by using the term DiagServiceEventSource. The term will return true if and only if the Event originates from a 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
Boolean Returns true if and only if the Event originates from a DiagServiceEventSource term, otherwise false.

Properties

Name Data Type Class Default Cardinality Description
Event Event Value - [1] Represents the Event whose type will be tested.

OTL Examples

/// Local Declarations

DiagCom.DiagService DiagService1;
EventHandling.EventSource EventSource1;
EventHandling.Event Event1;
DiagCom.ComChannel ComChannel1;
Boolean Boolean1;

/// Flow

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

parallel
{
	lane
	{
		DiagCom.ExecuteDiagService(DiagService1, {}, {}, NULL, NULL, false, false);
	}
	lane
	{
		EventHandling.WaitForEvent({EventSource1}, Event1);
	}
}

Boolean1 = DiagCom.IsDiagServiceEvent(Event1);

See also

GetComChannel
CreateDiagServiceByName
ExecuteDiagService
WaitForEvent
GetDiagServiceFromEvent
DiagServiceEventSource