OTX Reference  
OpenTestSystem.Otx.Extensions.DiagCom.Actions.GetAllResultsAndClear Class Reference

Entries of results of a diagnostic service More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.DiagCom.Actions.GetAllResultsAndClear:
Inheritance graph

Public Attributes

DiagServiceValue diagService
 Diagnostic service reference handle. More...
 
ListVariable resultList
 List to which the list of Result items be assigned. More...
 
- Public Attributes inherited from OpenTestSystem.Otx.Core.Actions.ActionRealisation
OtxLink validFor
 Validity of ActionRealisation. More...
 

Detailed Description

Entries of results of a diagnostic service

The GetAllResultsAndClear activity retrieves all available result entries from a diagnostic service and then clears the diagnostic communication system's result buffer. The results are provided as a list of Result objects. In comparison to the GetAllResults GetAllResultsAndClear is modelled as an ActionRealisation because it changes the DiagService object it is invoked on by clearing its result buffer.

The results are provided as a list of Result elements.
The DiagCom action GetAllResultsAndClear fetches all results present at the time of the call out of the communication component's result buffer and tells the communication component to clear the buffer afterwards. The list of results that is returned to OTX will be in ascending order from first (oldest) to last (most recent) result.

Checker rules
CheckerRule.DiagCom_Chk002 - Type-safe GetAllResultsAndClear
Syntax
DiagCom.GetAllResultsAndClear(DiagServiceValue diagService, ListVariable resultList);
ListVariable resultList
List to which the list of Result items be assigned.
Definition: DiagCom.cs:1663
DiagServiceValue diagService
Diagnostic service reference handle.
Definition: DiagCom.cs:1653
Examples
// Local Declarations
DiagCom.ComChannel ComChannel1;
DiagCom.DiagService DiagService1;
List<DiagCom.Result> ListOfResults1;
// 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);
DiagCom.GetAllResultsAndClear(DiagService1, ListOfResults1);

Member Data Documentation

◆ diagService

DiagServiceValue OpenTestSystem.Otx.Extensions.DiagCom.Actions.GetAllResultsAndClear.diagService

Diagnostic service reference handle.

◆ resultList

ListVariable OpenTestSystem.Otx.Extensions.DiagCom.Actions.GetAllResultsAndClear.resultList

List to which the list of Result items be assigned.