Difference between revisions of "Extensions.DiagCom.GetAllResults"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetAllResults'''}}[[Category:DiagCom]]
 
{{DISPLAYTITLE:OTX '''GetAllResults'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetAllResults | List of all results of diagnostic services performed | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Result related terms]] | - | - }}
+
{{ClassificationActivity | GetAllResults | Gets all available results of a diagnostic service | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|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;">
 
ListTerm = DiagCom.GetAllResults(DiagServiceTerm);
 
ListTerm = DiagCom.GetAllResults(DiagServiceTerm);
−
</syntaxhighlight>
+
</syntaxhighlight>  
  
 
== Description ==
 
== Description ==
−
The '''GetAllResults''' term is a list of all the results of a diagnostic services that run back. This is necessary especially for the evaluation of the responses of several ECUs.
+
The '''GetAllResults''' term returns all available results of a diagnostic service as a '''ListTerm'''. The list contains Result objects. This term only reads [[Extensions.DiagCom.Result|Result]] entries and does not delete the buffer containing the results. Possible use case is the monitoring of results without changing the state of the '''DiagService'''. '''GetAllResults''' is derived from '''ListTerm'''.
−
 
 
−
The list is returned in time ausfsteigender order. That is the first entry is the oldest object, last entry is newest object.
 
−
 
 
−
In contrast to the  [[Extensions.DiagCom.GetAllResultsAndClear|GetAllResultsAndClear]] activity, this term reads only the results of diagnostic services performed and does not clear the internal buffer, so that the results continue to be evaluated for other activities. One application for this is for example the '''monitoring of diagnostic communication'''.
 
  
−
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | List of result object of diagnostic services.}}
+
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.List|List]] | The List of all available results of a diagnostic service.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| DiagService | [[Core.DataTypes.ComplexDataType.DiagService|DiagService]] | [[Term]] | - | [1] | Diagnostics Service.}}
+
{{TableRowPropertie1| DiagService | [[Extensions.DiagCom.DiagService|DiagService]] | [[Term]] | - | [1] | Represents the '''DiagService''' of which the '''Results''' 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.ComChannel ComChannel1;
 
DiagCom.DiagService DiagService1;
 
DiagCom.DiagService DiagService1;
 
List<DiagCom.Result> List1;
 
List<DiagCom.Result> List1;
  
−
myComCannel = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", "", false);
+
/// Flow
−
DiagService1 = DiagCom.CreateDiagServiceByName(myComCannel, "DiagnServi_ReadDataByIdentActuaTestStatu");
+
 
−
DiagCom.SetRepetitionTime(DiagService1, 50);
+
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
 +
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu");
 +
DiagCom.SetRepetitionTime(DiagService1, 5);
 
DiagCom.StartRepeatedExecution(DiagService1);
 
DiagCom.StartRepeatedExecution(DiagService1);
−
DiagCom.ExecuteDiagService(DiagService1, {}, {}, false, false);
+
EventHandling.Sleep(50);
 
DiagCom.StopRepeatedExecution(DiagService1);
 
DiagCom.StopRepeatedExecution(DiagService1);
 
List1 = DiagCom.GetAllResults(DiagService1);
 
List1 = DiagCom.GetAllResults(DiagService1);
Line 39: Line 37:
  
 
== See also ==
 
== See also ==
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.SetRepetitionTime|SetRepetitionTime]] <br/>
 +
[[Extensions.DiagCom.StartRepeatedExecution|StartRepeatedExecution]] <br/>
 +
[[Extensions.DiagCom.StopRepeatedExecution|StopRepeatedExecution]] <br/>
 
[[Extensions.DiagCom.GetFirstResult|GetFirstResult]] <br/>
 
[[Extensions.DiagCom.GetFirstResult|GetFirstResult]] <br/>
 
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]]
 
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]]

Revision as of 08:19, 12 October 2018

Classification

Name GetAllResults
Short Description Gets all available results of a diagnostic service
Class Term
Extension OTX DiagCom extension
Group Result related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm = DiagCom.GetAllResults(DiagServiceTerm);

Description

The GetAllResults term returns all available results of a diagnostic service as a ListTerm. The list contains Result objects. This term only reads Result entries and does not delete the buffer containing the results. Possible use case is the monitoring of results without changing the state of the DiagService. GetAllResults is derived from ListTerm.

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
List The List of all available results of a diagnostic service.

Properties

Name Data Type Class Default Cardinality Description
DiagService DiagService Term - [1] Represents the DiagService of which the Results shall be returned.

OTL Examples

DiagCom.ComChannel ComChannel1;
DiagCom.DiagService DiagService1;
List<DiagCom.Result> List1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu");
DiagCom.SetRepetitionTime(DiagService1, 5);
DiagCom.StartRepeatedExecution(DiagService1);
EventHandling.Sleep(50);
DiagCom.StopRepeatedExecution(DiagService1);
List1 = DiagCom.GetAllResults(DiagService1);

See also

GetComChannel
CreateDiagServiceByName
SetRepetitionTime
StartRepeatedExecution
StopRepeatedExecution
GetFirstResult
ExecuteDiagService

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