Difference between revisions of "Extensions.DiagCom.GetResponseName"

From emotive
Jump to navigation Jump to search
(Created page with "<big>Big text</big>Category:DiagCom == Classification == {{ClassificationActivity | GetResponseName | Name of a Response | Term | OTX DiagCom extension | [...")
 
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<big>Big text</big>[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''GetResponseName'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetResponseName | Name of a Response | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Response related terms]] | - | - }}
+
{{ClassificationActivity | GetResponseName | Gets the name of a '''Response''' | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|Response related terms]] | - | - }}
  
−
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
GetResponseName(Response response, String responseName);
+
StringTerm DiagCom.GetResponseName(ResponseTerm response);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetResponseName''' term gives the name of the response back. This can be used, for example, to test based on the name, whether the response from the control unit is positive or negative, but also see [[IsPositive]].
+
The '''GetResponseName''' term retrieve the name of a [[Extensions.DiagCom.Response|Response]]. For example it can be used to determine whether a [[Extensions.DiagCom.Response|Response]] is positive or negative by comparing the response name with preset response names valid for the vehicle communication component.
  
−
{{TermReturnValue| [[String]] | Name of a [[Response]].}}
+
{{Note|In case a MVCI/ODX system is used the '''GetResponseName''' term returns the '''SHORT-NAME''' of the associated '''MCDResponse''' object.}}
 +
 
 +
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The name of a [[Extensions.DiagCom.Response|Response]].}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Response | [[Response]] | [[Term]] | - | [1] | Response object.}}
+
{{TableRowPropertie2| Response | [[Extensions.DiagCom.Response|Response]] | [[Term]] | - | [1] | The '''Response''' whose name will be returned.}}
 
|}
 
|}
  
−
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
String responseName = GetResponseName(response);
+
/// Local Declarations
 +
 
 +
DiagCom.Result Result1;
 +
DiagCom.Response Response1;
 +
String ResponseName1 = "";
 +
DiagCom.ComChannel ComChannel1;
 +
 
 +
/// Flow
 +
 
 +
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
 +
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
 +
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, Result1, NULL, false, false);
 +
Response1 = DiagCom.GetFirstResponse(Result1);
 +
ResponseName1 = DiagCom.GetResponseName(Response1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetAllResponses]] <br/>
+
[[Extensions.DiagCom.GetAllResponses|GetAllResponses]] <br/>
−
[[IsPositive]] <br/>
+
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/>
−
[[GetFirstResponse]] <br/>
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
−
[[ExecuteDiagService]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
−
[[GetFirstResult]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetFirstResult|GetFirstResult]] <br/>
 +
[[Extensions.DiagCom.GetAllResults|GetAllResults]] <br/>

Latest revision as of 10:06, 12 September 2019

Classification

Name GetResponseName
Short Description Gets the name of a Response
Class Term
Extension OTX DiagCom extension
Group Response related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm DiagCom.GetResponseName(ResponseTerm response);

Description

The GetResponseName term retrieve the name of a Response. For example it can be used to determine whether a Response is positive or negative by comparing the response name with preset response names valid for the vehicle communication component.

Icons Note.png In case a MVCI/ODX system is used the GetResponseName term returns the SHORT-NAME of the associated MCDResponse object.

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 name of a Response.

Properties

Name Data Type Class Default Cardinality Description
Response Response Term - [1] The Response whose name will be returned.

OTL Examples

/// Local Declarations

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

/// Flow

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

See also

GetAllResponses
GetFirstResponse
GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResult
GetAllResults

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