Difference between revisions of "Extensions.DiagCom.GetComChannelIdentifierFromResponse"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetComChannelIdentifierFromResponse'''}}[[Category:DiagCom]]
 
{{DISPLAYTITLE:OTX '''GetComChannelIdentifierFromResponse'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetComChannelIdentifierFromResponse | Determined from a response to the associated communication channel | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[ComChanel related terms]] | [[Core.Actions.Throw.Exception.UnknownComChannelException|UnknownComChannelException]] | - }}
+
{{ClassificationActivity | GetComChannelIdentifierFromResponse | Accepts a response and returns the identifier of the communication channel | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|ComChanel related terms]] | [[Extensions.DiagCom.UnknownComChannelException|UnknownComChannelException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.GetComChannelIdentifierFromResponse(ResponseTerm);
+
StringTerm = DiagCom.GetComChannelIdentifierFromResponse(ResponseTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
On the '''GetComChannelIdentifierFromResponse''' term can be determined from a response of the corresponding communication channel. This is especially necessary for the evaluation of a result object, which in the functional addressing  contains the answers of several control units.  
+
The '''GetComChannelIdentifierFromResponse''' term accepts a response and returns the identifier of the communication channel associated with the [[ECU]] that sent the response. This term is especially useful for results containing responses from different ECUs.
  
−
{{TermReturnValue| [[Extensions.DiagCom.ComChannel|ComChannel]] | It will return the communication channel generated.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The identifier of the communication channel associated with the [[ECU]] that sent the response.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Response | [[Extensions.DiagCom.Response|Response]] | [[Term]] | - | [1] | Response object that is returned by the control unit.}}
+
{{TableRowPropertie1| Response | [[Extensions.DiagCom.Response|Response]] | [[Term]] | - | [1] | This element specifies the response of which the originating [[ECU]] shall be returned.}}
 
|}
 
|}
  
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.ComChannel myComCannel;
+
DiagCom.ComChannel ComChannel1;
−
DiagCom.DiagService myDiagService;
 
 
DiagCom.Result Result1;
 
DiagCom.Result Result1;
 
DiagCom.Response Response1;
 
DiagCom.Response Response1;
−
String String1;
+
String Identifier1 = "";
  
−
myComCannel = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", null, false);
+
/// Flow
−
myDiagService = DiagCom.CreateDiagServiceByName(myComCannel, "DiagnServi_ReadDataByIdentActuaTestStatu");
+
 
−
DiagCom.ExecuteDiagService(myDiagService, {}, {}, false, false, Result1);
+
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
−
Response1 = DiagCom.GetFirstResponse(Result1);
+
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
−
String1 = DiagCom.GetComChannelIdentifierFromResponse(Response1);
+
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, Result1, NULL, false, false);
 +
Response1 = DiagCom.GetFirstResponse(Result1, );
 +
Identifier1 = DiagCom.GetComChannelIdentifierFromResponse(Response1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
 
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
−
[[Extensions.DiagCom.GetComChannelEcuVariantName|GetComChannelEcuVariantName]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
−
[[Extensions.DiagCom.IsVariant|IsVariant]]
+
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/>
 +
[[Extensions.DiagCom.GetAllResponses|GetAllResponses]] <br/>

Revision as of 09:44, 11 October 2018

Classification

Name GetComChannelIdentifierFromResponse
Short Description Accepts a response and returns the identifier of the communication channel
Class Term
Extension OTX DiagCom extension
Group ComChanel related terms
Exceptions UnknownComChannelException
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm = DiagCom.GetComChannelIdentifierFromResponse(ResponseTerm);

Description

The GetComChannelIdentifierFromResponse term accepts a response and returns the identifier of the communication channel associated with the ECU that sent the response. This term is especially useful for results containing responses from different ECUs.

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
String The identifier of the communication channel associated with the ECU that sent the response.

Properties

Name Data Type Class Default Cardinality Description
Response Response Term - [1] This element specifies the response of which the originating ECU shall be returned.

OTL Examples

DiagCom.ComChannel ComChannel1;
DiagCom.Result Result1;
DiagCom.Response Response1;
String Identifier1 = "";

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, Result1, NULL, false, false);
Response1 = DiagCom.GetFirstResponse(Result1, );
Identifier1 = DiagCom.GetComChannelIdentifierFromResponse(Response1);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetAllResponses

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.DiagCom.GetComChannelIdentifierFromResponse&oldid=7711"