Difference between revisions of "Extensions.DiagCom.StartRepeatedExecution"

From emotive
Jump to navigation Jump to search
(Created page with "Category:DiagCom == Classification == {{ClassificationActivity | StartRepeatedExecution | Executing repeatedly a DiagService | Action | DiagCom|OTX DiagCom exten...")
 
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''StartRepeatedExecution'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | StartRepeatedExecution | Executing repeatedly a [[DiagService]] | [[Action]] | [[DiagCom|OTX DiagCom extension]] | [[DiagService related actions]] | [[InvalidStateException]] <br/> [[IncompleteParameterizationException]] | - }}
+
{{ClassificationActivity | StartRepeatedExecution | Executing repeatedly a [[Core.DataTypes.ComplexDataType.DiagService|DiagService]] | [[Action]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[DiagService related actions]] | [[Extensions.DiagCom.InvalidStateException|InvalidStateException]] <br/> [[Extensions.DiagCom.IncompleteParameterizationException|IncompleteParameterizationException]] | - }}
  
−
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
StartRepeatedExecution(DiagService myDiagService);
+
DiagCom.StartRepeatedExecution(DiagServiceValue diagService);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The OTX '''StartRepeatedExecution''' action be used to executed repeatedly a [[DiagService]]. The repetition time shall be set through the [[SetRepetitionTime]] action and queried by the [[GetRepetitionTime]] term. To stop a repeated service execution, the [[StopRepeatedExecution]] action is to be used.
+
The OTX '''StartRepeatedExecution''' action be used to executed repeatedly a [[Core.DataTypes.ComplexDataType.DiagService|DiagService]] by the underlying communication backend. The repetition time will be set through the [[Extensions.DiagCom.SetRepetitionTime|SetRepetitionTime]] action and queried by the [[Extensions.DiagCom.GetRepetitionTime|GetRepetitionTime]] term. The behavior depends on the underplaying System. Especially if the
 +
RepetitionTime value is 0 or lower than the physical possible repetition time. The '''StartRepeatedExecution''' action will return immediately, 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. Each new result (each execution cycle) will cause a '''DiagServiceEvent''' to be raised by the '''DiagService''' object. To stop a repeated service execution, the [[Extensions.DiagCom.StopRepeatedExecution|StopRepeatedExecution]] 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 be executed repeatedly.}}
 
|}
 
|}
  
−
== 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;
 +
 
 +
/// 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);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetComChannel]] <br/>
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
−
[[CreateDiagServiceByName]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
−
[[StopRepeatedExecution]] <br/>
+
[[Extensions.DiagCom.StopRepeatedExecution|StopRepeatedExecution]] <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 08:36, 9 December 2019

Classification

Name StartRepeatedExecution
Short Description Executing repeatedly a DiagService
Class Action
Extension OTX DiagCom extension
Group DiagService related actions
Exceptions InvalidStateException
IncompleteParameterizationException
Checker Rules -
Standard Compliant Yes

OTL Syntax

DiagCom.StartRepeatedExecution(DiagServiceValue diagService);

Description

The OTX StartRepeatedExecution action be used to executed repeatedly a DiagService by the underlying communication backend. The repetition time will be set through the SetRepetitionTime action and queried by the GetRepetitionTime term. The behavior depends on the underplaying System. Especially if the RepetitionTime value is 0 or lower than the physical possible repetition time. The StartRepeatedExecution action will return immediately, the results of the DiagService created by the repeated service execution can be queried through the GetFirstResult or GetAllResults terms or the GetAllResultsAndClear action. Each new result (each execution cycle) will cause a DiagServiceEvent to be raised by the DiagService object. To stop a repeated service execution, the StopRepeatedExecution action is to be used.

Properties

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

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
StopRepeatedExecution
SetRepetitionTime
GetRepetitionTime
GetAllResults
GetFirstResult
GetAllResultsAndClear

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