Difference between revisions of "Extensions.Job.AddElement"

From emotive
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:  '''AddElement '''}}
 
{{DISPLAYTITLE:  '''AddElement '''}}
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | AddElement | Add parameters or parameter structure | [[Action]] | [[Extensions.Job|OTX Job extension]] | [[Job related actions]] | [[Core.Actions.Throw.Exception.TypeMismatchException|TypeMismatchException]] | - }}
+
{{ClassificationActivity | AddElement | Add parameters or parameter structure | [[Action]] | [[Extensions.Job|OTX Job extension]] | [[Extensions.Job#Actions|Job related actions]] | [[Core.DataTypes.ComplexDataType.TypeMismatchException|TypeMismatchException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Job.AddElement(ParameterContainer, ParameterContainer);
+
Job.AddElement(ParameterContainerTerm parameterContainer, ParameterContainerTerm content);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
'''AddElement''' is used to add a parameter or a parameter structure to a point in a response structure.
+
The '''AddElement''' is used to add a parameter or parameter structure to a point in a response structure.
  
 
== Properties ==
 
== Properties ==
Line 20: Line 20:
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
DiagCom.Request ParameterContainer1;
+
/// Local Declarations
  
Job.AddElement(ParameterContainer1, ParameterContainer1);
+
DiagCom.ComChannel ComChannel1;
 +
DiagCom.DiagService DiagService1;
 +
DiagCom.Result Result1;
 +
DiagCom.Response Response1;
 +
DiagCom.Parameter Parameter1;
 +
 
 +
/// Flow
 +
 
 +
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false);
 +
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentECUIdent");
 +
[#MetaData(RequestPdu), <#Data>22 04 07</#Data>]
 +
DiagCom.ExecuteDiagService(DiagService1, {Param_RecorDataIdent = "VW Logical Software Block Counter Of Programming Attempts"}, {}, Result1, NULL, false, false);
 +
Response1 = DiagCom.GetFirstResponse(Result1);
 +
Parameter1 = DiagCom.GetParameterByPath(Response1, {"Param_DataRecor"});
 +
Job.AddElement(Response1, Parameter1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 29: Line 43:
 
[[Extensions.Job.SendIntermediateResult|SendIntermediateResult]]<br/>
 
[[Extensions.Job.SendIntermediateResult|SendIntermediateResult]]<br/>
 
[[Extensions.Job.SetJobInfo|SetJobInfo]]<br/>
 
[[Extensions.Job.SetJobInfo|SetJobInfo]]<br/>
[[Extensions.Job.SetProgressInfo|SetProgressInfo]]<br/>
+
[[Extensions.Job.SetProgressInfo|SetProgressInfo]]<br/>
 +
<!--[[Extensions.Job.AddElement|AddElement]]<br/>-->
 
[[Extensions.Job.AddBranchByName|AddBranchByName]]<br/>
 
[[Extensions.Job.AddBranchByName|AddBranchByName]]<br/>
 
[[Extensions.Job.AddBranchByIndex|AddBranchByIndex]]<br/>
 
[[Extensions.Job.AddBranchByIndex|AddBranchByIndex]]<br/>
 
[[Extensions.Job.AddBranchByValue|AddBranchByValue]]<br/>
 
[[Extensions.Job.AddBranchByValue|AddBranchByValue]]<br/>
[[Extensions.Job.AddEnvDataByDtc|AddEnvDataByDtc]]
+
[[Extensions.Job.AddEnvDataByDtc|AddEnvDataByDtc]]<br/>
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]]<br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]]<br/>
 +
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]]<br/>
 +
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]]<br/>
 +
[[Extensions.DiagCom.GetRequest|GetRequest]]<br/>

Latest revision as of 07:29, 7 November 2018

Classification

Name AddElement
Short Description Add parameters or parameter structure
Class Action
Extension OTX Job extension
Group Job related actions
Exceptions TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

Job.AddElement(ParameterContainerTerm parameterContainer, ParameterContainerTerm content);

Description

The AddElement is used to add a parameter or parameter structure to a point in a response structure.

Properties

Name Data Type Class Default Cardinality Description
ParameterContainer ParameterContainer Term - [1] The parameters in which new element (s) to be added.
Content ParameterContainer Term - [0..1] The item (s) is added to the parameter container.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel1;
DiagCom.DiagService DiagService1;
DiagCom.Result Result1;
DiagCom.Response Response1;
DiagCom.Parameter Parameter1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentECUIdent");
[#MetaData(RequestPdu), <#Data>22 04 07</#Data>]
DiagCom.ExecuteDiagService(DiagService1, {Param_RecorDataIdent = "VW Logical Software Block Counter Of Programming Attempts"}, {}, Result1, NULL, false, false);
Response1 = DiagCom.GetFirstResponse(Result1);
Parameter1 = DiagCom.GetParameterByPath(Response1, {"Param_DataRecor"});
Job.AddElement(Response1, Parameter1);

See also

SendFinalResult
SendIntermediateResult
SetJobInfo
SetProgressInfo
AddBranchByName
AddBranchByIndex
AddBranchByValue
AddEnvDataByDtc
GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetFirstResponse
GetRequest