Difference between revisions of "Extensions.Job.AddElement"
Jump to navigation
Jump to search
m (Hb moved page AddElement to Extensions.Job.AddElement: #3153) |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | {{DISPLAYTITLE: '''AddElement '''}} | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | AddElement | Add parameters or parameter structure | [[Action]] | [[Job|OTX Job extension]] | [[Job related actions]] | [[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( | + | Job.AddElement(ParameterContainerTerm parameterContainer, ParameterContainerTerm content); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | '''AddElement''' is used to add a parameter or | + | The '''AddElement''' is used to add a parameter or parameter structure to a point in a response structure. |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ParameterContainer | [[ParameterContainer]] | [[Term]] | - | [1] | The parameters in which new element (s) to be added.}} | + | {{TableRowPropertie1| ParameterContainer | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [1] | The parameters in which new element (s) to be added.}} |
| − | {{TableRowPropertie2| Content | [[ParameterContainer]] | [[Term]] | - | [0..1] | The item (s) is added to the parameter container.}} | + | {{TableRowPropertie2| Content | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [0..1] | The item (s) is added to the parameter container.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | /// Local Declarations | |
| − | Job.AddElement( | + | 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> | ||
== See also == | == See also == | ||
| − | [[SendFinalResult]]<br/> | + | [[Extensions.Job.SendFinalResult|SendFinalResult]]<br/> |
| − | [[SendIntermediateResult]]<br/> | + | [[Extensions.Job.SendIntermediateResult|SendIntermediateResult]]<br/> |
| − | [[SetJobInfo]]<br/> | + | [[Extensions.Job.SetJobInfo|SetJobInfo]]<br/> |
| − | [[SetProgressInfo]]<br/> | + | [[Extensions.Job.SetProgressInfo|SetProgressInfo]]<br/> |
| − | [[AddBranchByName]]<br/> | + | <!--[[Extensions.Job.AddElement|AddElement]]<br/>--> |
| − | [[AddBranchByIndex]]<br/> | + | [[Extensions.Job.AddBranchByName|AddBranchByName]]<br/> |
| − | [[AddBranchByValue]]<br/> | + | [[Extensions.Job.AddBranchByIndex|AddBranchByIndex]]<br/> |
| − | [[AddEnvDataByDtc]] | + | [[Extensions.Job.AddBranchByValue|AddBranchByValue]]<br/> |
| + | [[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
