Difference between revisions of "Extensions.DiagCom.GetFirstResponse"

From emotive
Jump to navigation Jump to search
Line 5: Line 5:
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
ResponseTerm = DiagCom.GetFirstResponse(ResultTerm);
+
/// Local Declarations
 +
DiagCom.Response ResponseVariable;
 +
/// Flow
 +
ResponseVariable = DiagCom.GetFirstResponse(ResultTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 21: Line 24:
 
== 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.Result Result1;
 
DiagCom.Result Result1;
 
DiagCom.Response Response1;
 
DiagCom.Response Response1;

Revision as of 10:27, 23 October 2018

Classification

Name GetFirstResponse
Short Description Gets first Response of a result object
Class Term
Extension OTX DiagCom extension
Group Response related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

/// Local Declarations
DiagCom.Response ResponseVariable;
/// Flow
ResponseVariable = DiagCom.GetFirstResponse(ResultTerm);

Description

The GetFirstResponse term is used to retrieve the first Response of a Result handle. In case there is more than one Response available in a Result, only the first Response will be returned.

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
Response First Response of a Result object.

Properties

Name Data Type Class Default Cardinality Description
ResultEcu Result Term - [1] The Result whose first response shall be returned.

OTL Examples

/// Local Declarations

DiagCom.Result Result1;
DiagCom.Response Response1;
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);

See also

GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetFirstResult
GetAllResults