Difference between revisions of "Extensions.DiagCom.GetFirstResponse"
Jump to navigation
Jump to search
| (6 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{DISPLAYTITLE:OTX '''GetFirstResponse'''}}[[Category:DiagCom]] | |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetFirstResponse | | + | {{ClassificationActivity | GetFirstResponse | Gets first Response of a result object | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|Response related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | ResponseTerm | + | ResponseTerm DiagCom.GetFirstResponse(ResultTerm result); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetFirstResponse''' term | + | The '''GetFirstResponse''' term is used to retrieve the first [[Extensions.DiagCom.Response|Response]] of a [[Extensions.DiagCom.Result|Result]] handle. In case there is more than one [[Extensions.DiagCom.Response|Response]] available in a [[Extensions.DiagCom.Result|Result]], only the first [[Extensions.DiagCom.Response|Response]] will be returned. |
| − | {{TermReturnValue| [[Response]] | First Response of a | + | {{TermReturnValue| [[Extensions.DiagCom.Response|Response]] | First '''Response''' of a '''Result''' object.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Result | [[Extensions.DiagCom.Result|Result]] | [[Term]] | - | [1] | The '''Result''' whose first response will be returned.}} |
|} | |} | ||
== 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; | ||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
| − | |||
| − | ComChannel1 = DiagCom.GetComChannel(" | + | /// 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); | Response1 = DiagCom.GetFirstResponse(Result1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[ | + | [[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> |
| − | [[ | + | [[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/> |
| − | [[ | + | [[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/> |
| − | [[ | + | [[Extensions.DiagCom.GetFirstResult|GetFirstResult]] <br/> |
| − | [[ | + | [[Extensions.DiagCom.GetAllResults|GetAllResults]] |
Latest revision as of 10:13, 12 September 2019
Contents
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
ResponseTerm DiagCom.GetFirstResponse(ResultTerm result);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.
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 |
| Result | Result | Term | - | [1] | The Result whose first response will 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
