Difference between revisions of "Extensions.DiagCom.GetResultState"
Jump to navigation
Jump to search
(Created page with "<big>Big text</big>Category:DiagCom == Classification == {{ClassificationActivity | GetResultState | The state of Result | Term | OTX DiagCom extension...") |
|||
| (13 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{DISPLAYTITLE:OTX '''GetResultState'''}}[[Category:DiagCom]] | |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetResultState | | + | {{ClassificationActivity | GetResultState | Gets the state of a [[Extensions.DiagCom.Result|Result]] | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|Result related terms]] | - | - }} |
| − | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | GetResultState( | + | ResultStateTerm DiagCom.GetResultState(ResultTerm result); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetResultState''' term retrieve the state of a [[Result]](i.e. whether the ECU(s) answered at all, correctly, positively or negatively). | + | The '''GetResultState''' term retrieve the state of a [[Extensions.DiagCom.Result|Result]] (i.e. whether the ECU(s) answered at all, correctly, positively or negatively). |
| + | |||
| + | {{TermReturnValue| [[Extensions.DiagCom.ResultState|ResultState]] | The state of the [[Extensions.DiagCom.Result|Result]].}} | ||
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Result | [[Extensions.DiagCom.Result|Result]] | [[Term]] | - | [1] | The '''Result''' whose state will be returned.}} |
| − | |||
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | ResultState | + | /// Local Declarations |
| + | |||
| + | DiagCom.DiagService DiagService1; | ||
| + | DiagCom.Result Result1; | ||
| + | DiagCom.ResultState ResultState1 = @ResultState:ALL_INVALID; | ||
| + | DiagCom.ComChannel ComChannel1; | ||
| + | |||
| + | /// Flow | ||
| + | |||
| + | ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false); | ||
| + | DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"); | ||
| + | [#MetaData(RequestPdu), <#Data>22 01 00</#Data>] | ||
| + | DiagCom.ExecuteDiagService(DiagService1, {}, {}, NULL, NULL, false, false); | ||
| + | Result1 = DiagCom.GetFirstResult(DiagService1); | ||
| + | ResultState1 = DiagCom.GetResultState(Result1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[GetFirstResult]] <br/> | + | [[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> |
| − | [[GetAllResults]] | + | [[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/> |
| + | [[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <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 | GetResultState |
| Short Description | Gets the state of a Result |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | Result related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
ResultStateTerm DiagCom.GetResultState(ResultTerm result);Description
The GetResultState term retrieve the state of a Result (i.e. whether the ECU(s) answered at all, correctly, positively or negatively).
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| ResultState | The state of the Result. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Result | Result | Term | - | [1] | The Result whose state will be returned. |
OTL Examples
/// Local Declarations
DiagCom.DiagService DiagService1;
DiagCom.Result Result1;
DiagCom.ResultState ResultState1 = @ResultState:ALL_INVALID;
DiagCom.ComChannel ComChannel1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu");
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
DiagCom.ExecuteDiagService(DiagService1, {}, {}, NULL, NULL, false, false);
Result1 = DiagCom.GetFirstResult(DiagService1);
ResultState1 = DiagCom.GetResultState(Result1);See also
GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResult
GetAllResults
