Difference between revisions of "Extensions.DiagCom.GetResultState"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetResultState'''}}[[Category:DiagCom]]
 
{{DISPLAYTITLE:OTX '''GetResultState'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetResultState | The state of [[Extensions.DiagCom.Result|Result]] | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Result related terms]] | - | - }}
+
{{ClassificationActivity | GetResultState | Gets the state of a [[Extensions.DiagCom.Result|Result]] | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Result related terms]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
ResultState = DiagCom.GetResultState(ResultTerm);
+
ResultStateTerm = DiagCom.GetResultState(ResultTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 11: Line 11:
 
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).
 
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]] | State of the [[Extensions.DiagCom.Result|Result]].}}
+
{{TermReturnValue| [[Extensions.DiagCom.ResultState|ResultState]] | The state of the [[Extensions.DiagCom.Result|Result]].}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ResultEcu | [[Extensions.DiagCom.Result|Result]] | [[Term]] | - | [1] | Result object.}}
+
{{TableRowPropertie1| ResultEcu | [[Extensions.DiagCom.Result|Result]] | [[Term]] | - | [1] | The Result whose state 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.DiagService DiagService1;
 
DiagCom.DiagService DiagService1;
 
DiagCom.Result Result1;
 
DiagCom.Result Result1;
DiagCom.ResultState ResultState1 = @ResultStates:ALL_INVALID;
+
DiagCom.ResultState ResultState1 = @ResultState:ALL_INVALID;
 +
DiagCom.ComChannel ComChannel1;
  
myComCannel = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", "", false);
+
/// Flow
DiagService1 = DiagCom.CreateDiagServiceByName(myComCannel, "DiagnServi_ReadDataByIdentActuaTestStatu");
+
 
DiagCom.StartRepeatedExecution(DiagService1);
+
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
DiagCom.ExecuteDiagService(DiagService1, {}, {}, false, false);
+
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu");
DiagCom.StopRepeatedExecution(DiagService1);
+
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
 +
DiagCom.ExecuteDiagService(DiagService1, {}, {}, NULL, NULL, false, false);
 
Result1 = DiagCom.GetFirstResult(DiagService1);
 
Result1 = DiagCom.GetFirstResult(DiagService1);
 
ResultState1 = DiagCom.GetResultState(Result1);
 
ResultState1 = DiagCom.GetResultState(Result1);
Line 36: Line 37:
  
 
== See also ==
 
== See also ==
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 
[[Extensions.DiagCom.GetFirstResult|GetFirstResult]] <br/>
 
[[Extensions.DiagCom.GetFirstResult|GetFirstResult]] <br/>
 
[[Extensions.DiagCom.GetAllResults|GetAllResults]]
 
[[Extensions.DiagCom.GetAllResults|GetAllResults]]

Revision as of 08:33, 12 October 2018

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);

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.

Icons Note.png 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
ResultEcu Result Term - [1] The Result whose state shall be returned.

OTL Examples

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