Difference between revisions of "Extensions.DiagCom.IsDiagServiceEvent"
Jump to navigation
Jump to search
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:DiagCom]] | + | {{DISPLAYTITLE:OTX '''IsDiagServiceEvent'''}}[[Category:DiagCom]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | IsDiagServiceEvent | Checks | + | {{ClassificationActivity | IsDiagServiceEvent | Checks the type of the Event | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|Event related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | BooleanTerm | + | BooleanTerm DiagCom.IsDiagServiceEvent(EventValue event); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''IsDiagServiceEvent''' term | + | The '''IsDiagServiceEvent''' term accepts an '''EventValue''' term yielding an [[Extensions.EventHandling.Event|Event]] object that has been raised by the OTX runtime, as a result of declaring a [[Extensions.DiagCom.DiagService|DiagService]] object as an event source by using the term [[Extensions.DiagCom.DiagServiceEventSource|DiagServiceEventSource]]. The term will return '''true''' if and only if the [[Extensions.EventHandling.Event|Event]] originates from a [[Extensions.DiagCom.DiagServiceEventSource|DiagServiceEventSource]] term. |
| − | {{TermReturnValue| [[Boolean]] | | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns '''true''' if and only if the [[Extensions.EventHandling.Event|Event]] originates from a [[Extensions.DiagCom.DiagServiceEventSource|DiagServiceEventSource]] term, otherwise '''false'''.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Event | [[Extensions.EventHandling.Event|Event]] | [[Value]] | - | [1] | Represents the '''Event''' whose type will be tested.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | /// Local Declarations | |
| + | |||
DiagCom.DiagService DiagService1; | DiagCom.DiagService DiagService1; | ||
EventHandling.EventSource EventSource1; | EventHandling.EventSource EventSource1; | ||
EventHandling.Event Event1; | EventHandling.Event Event1; | ||
| − | Boolean Boolean1 | + | DiagCom.ComChannel ComChannel1; |
| + | Boolean Boolean1; | ||
| + | |||
| + | /// Flow | ||
| − | + | ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false); | |
| − | DiagService1 = DiagCom.CreateDiagServiceByName( | + | DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_DiagnSessiContr"); |
EventSource1 = DiagCom.DiagServiceEventSource(DiagService1); | EventSource1 = DiagCom.DiagServiceEventSource(DiagService1); | ||
parallel | parallel | ||
{ | { | ||
| − | + | lane | |
| − | + | { | |
| − | + | DiagCom.ExecuteDiagService(DiagService1, {}, {}, NULL, NULL, false, false); | |
| − | + | } | |
| − | + | lane | |
| − | + | { | |
| − | + | EventHandling.WaitForEvent({EventSource1}, Event1); | |
| − | + | } | |
} | } | ||
| Line 47: | Line 51: | ||
== See also == | == See also == | ||
| − | [[GetDiagServiceFromEvent]] <br/> | + | [[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> |
| − | [[ | + | [[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/> |
| + | [[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/> | ||
| + | [[Extensions.EventHandling.WaitForEvent|WaitForEvent]] <br/> | ||
| + | [[Extensions.DiagCom.GetDiagServiceFromEvent|GetDiagServiceFromEvent]] <br/> | ||
| + | [[Extensions.DiagCom.DiagServiceEventSource|DiagServiceEventSource]] | ||
Latest revision as of 10:19, 12 September 2019
Contents
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.
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
