Difference between revisions of "Extensions.DiagCom.StopRepeatedExecution"

From emotive
Jump to navigation Jump to search
(Created page with "Category:DiagCom == Classification == {{ClassificationActivity | StopRepeatedExecution | Stop executing repeatedly a DiagService | Action | DiagCom|OTX DiagCom e...")
 
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''StopRepeatedExecution '''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | StopRepeatedExecution | Stop executing repeatedly a [[DiagService]] | [[Action]] | [[DiagCom|OTX DiagCom extension]] | [[DiagService related actions]] | [[InvalidStateException]] | - }}
+
{{ClassificationActivity | StopRepeatedExecution | Stops the repeated execution of a [[Extensions.DiagCom.DiagService|DiagService]] | [[Action]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[DiagService related actions]] | [[Extensions.DiagCom.InvalidStateException|InvalidStateException]] | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
StopRepeatedExecution(DiagService myDiagService);
+
DiagCom.StopRepeatedExecution(DiagServiceValue diagService);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
The OTX '''StopRepeatedExecution''' action be used to stop executed repeatedly a [[DiagService]].
+
The OTX '''StopRepeatedExecution''' action causes the repeated execution of a [[Extensions.DiagCom.DiagService|DiagService]] to be stopped. The results of the [[Extensions.DiagCom.DiagService|DiagService]] created by the repeated service execution can be queried through the [[Extensions.DiagCom.GetFirstResult|GetFirstResult]] / or [[Extensions.DiagCom.GetAllResults|GetAllResults]] terms or the [[Extensions.DiagCom.GetAllResultsAndClear|GetAllResultsAndClear]] action. To start a repeated service execution, the [[Extensions.DiagCom.StartRepeatedExecution|StartRepeatedExecution]] action is to be used.
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| DiagService | [[DiagService ]] | [[Term]] | - | [1] | The service which shall be executed repeatedly. }}
+
{{TableRowPropertie2| DiagService | [[Extensions.DiagCom.DiagService|DiagService ]] | [[Value]] | - | [1] | The element specifies the service which will not be executed repeatedly any more.}}
 
|}
 
|}
  
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
ComChannel myComCannel = GetComChannel("LL_AirbaUDS", "", false);
+
/// Local Declarations
DiagService myDiagService = CreateDiagServiceByName(myComChannel, "DiagnServi_ReadDataByIdentECUIdent");
 
  
StartRepeatedExecution(myDiagService);
+
DiagCom.DiagService DiagService1;
 +
List<DiagCom.Result> List1;
 +
DiagCom.ComChannel ComChannel1;
  
ExecuteDiagService(myDiagService, new RequestParameters<RequestParameter>() { { "Param_RecorDataIdent", "Spare Part Number" } }, new ResponseParameters<ResponseParameter>() { { "Resp_ReadDataByIdentECUIdent.Param_DataRecor.Param_SparePartNumbe", mySparePartNumberStringVariable } }, false, false);
+
/// Flow
  
StartRepeatedExecution(myDiagService);
+
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false);
 +
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_DiagnSessiContr");
 +
DiagCom.StartRepeatedExecution(DiagService1);
 +
EventHandling.Sleep(50);
 +
DiagCom.StopRepeatedExecution(DiagService1);
 +
List1 = DiagCom.GetAllResults(DiagService1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
[[GetComChannel]] <br/>
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
[[CreateDiagServiceByName]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
[[StartRepeatedExecution]] <br/>
+
[[Extensions.DiagCom.StartRepeatedExecution|StartRepeatedExecution]] <br/>
[[SetRepetitionTime]] <br/>
+
[[Extensions.DiagCom.SetRepetitionTime|SetRepetitionTime]] <br/>
[[GetRepetitionTime]]
+
[[Extensions.DiagCom.GetRepetitionTime|GetRepetitionTime]]<br/>
 +
[[Extensions.DiagCom.GetAllResults|GetAllResults]]<br/>
 +
[[Extensions.DiagCom.GetFirstResult|GetFirstResult]]<br/>
 +
[[Extensions.DiagCom.GetAllResultsAndClear|GetAllResultsAndClear]]

Latest revision as of 10:02, 12 September 2019

Classification

Name StopRepeatedExecution
Short Description Stops the repeated execution of a DiagService
Class Action
Extension OTX DiagCom extension
Group DiagService related actions
Exceptions InvalidStateException
Checker Rules -
Standard Compliant Yes

OTL Syntax

DiagCom.StopRepeatedExecution(DiagServiceValue diagService);

Description

The OTX StopRepeatedExecution action causes the repeated execution of a DiagService to be stopped. The results of the DiagService created by the repeated service execution can be queried through the GetFirstResult / or GetAllResults terms or the GetAllResultsAndClear action. To start a repeated service execution, the StartRepeatedExecution action is to be used.

Properties

Name Data Type Class Default Cardinality Description
DiagService DiagService Value - [1] The element specifies the service which will not be executed repeatedly any more.

OTL Examples

/// Local Declarations

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

/// Flow

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

See also

GetComChannel
CreateDiagServiceByName
StartRepeatedExecution
SetRepetitionTime
GetRepetitionTime
GetAllResults
GetFirstResult
GetAllResultsAndClear