Difference between revisions of "Extensions.DiagCom.GetAllResults"

From emotive
Jump to navigation Jump to search
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<big>Big text</big>[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''GetAllResults'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetAllResults | List of all results of diagnostic services performed | [[Term]] | [[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]] | - | - }}
  
−
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
List<Result> GetAllResults(DiagService diagService);
+
ListTerm DiagCom.GetAllResults(DiagServiceTerm diagService);
 
</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.
+
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.List|List]] | The List of all available results of a diagnostic service.}}
−
 
 
−
In contrast to the  [[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| [[List]] | List of result object of diagnostic services.}}
 
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| DiagService | [[DiagService]] | [[Term]] | - | [1] | Diagnostics Service.}}
+
{{TableRowPropertie2| DiagService | [[Extensions.DiagCom.DiagService|DiagService]] | [[Term]] | - | [1] | Represents the '''DiagService''' of which the '''Results''' will be returned.}}
 
|}
 
|}
  
−
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
List<Result> resultList = GetAllResults(diagService);
+
/// Local Declarations
 +
 
 +
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);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetFirstResult]] <br/>
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
−
[[ExecuteDiagService]]
+
[[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.ExecuteDiagService|ExecuteDiagService]]

Latest revision as of 10:13, 12 September 2019

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

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 will be returned.

OTL Examples

/// Local Declarations

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=9677"