Difference between revisions of "Extensions.Job.AddBranchByName"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''AddBranchByName '''}} | {{DISPLAYTITLE: '''AddBranchByName '''}} | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | AddBranchByName | Adds a set of response parameters with short name | [[Action]] | [[Extensions.Job|OTX Job extension]] | [[Job related actions]] | [[Core. | + | {{ClassificationActivity | AddBranchByName | Adds a set of response parameters with short name | [[Action]] | [[Extensions.Job|OTX Job extension]] | [[Job related actions]] | [[Core.DataTypes.ComplexDataType.TypeMismatchException|TypeMismatchException]]<br/>[[Extensions.Job.InvalidParameterizationException|InvalidParameterizationException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Job.AddBranchByName( | + | Job.AddBranchByName(ParameterContainerTerm, ParameterContainerTerm, StringTerm); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | '''AddBranchByName''' is used to add a | + | The '''AddBranchByName''' is used to add a set of response parameters to the response structure according to a multiplexer database definitioxn given by its short name. |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| ParameterContainer | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [1] | The parameters in which new element (s) to be added.}} |
| − | {{ | + | {{TableRowPropertie1| Content | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [0..1] | The element(s) to be placed in the newly created multiplexer branch.}} |
| + | {{TableRowPropertie2| ShortName| [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The name of the multiplexer branch to be added.}} | ||
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | DiagCom.Request | + | DiagCom.Request Request; |
| + | DiagCom.ComChannel ComChannel1; | ||
| + | DiagCom.DiagService DiagService1; | ||
| + | DiagCom.Result Result1; | ||
| + | DiagCom.Response Response1; | ||
| − | Job.AddBranchByName( | + | /// Flow |
| + | |||
| + | ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", NULL, false); | ||
| + | DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"); | ||
| + | [#MetaData(RequestPdu), <#Data>22 01 00</#Data>] | ||
| + | DiagCom.ExecuteDiagService(DiagService1, {}, {}, Result1, NULL, false, false); | ||
| + | Response1 = DiagCom.GetFirstResponse(Result); | ||
| + | Request = DiagCom.GetRequest(DiagService1); | ||
| + | Job.AddBranchByName(Response1, Request, "Read Data By Identifier / Actuator Test Status"); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 30: | Line 43: | ||
[[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.AddElement|AddElement]]<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/> | ||
Revision as of 04:44, 18 October 2018
Classification
| Name | AddBranchByName |
| Short Description | Adds a set of response parameters with short name |
| Class | Action |
| Extension | OTX Job extension |
| Group | Job related actions |
| Exceptions | TypeMismatchException InvalidParameterizationException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
Job.AddBranchByName(ParameterContainerTerm, ParameterContainerTerm, StringTerm);Description
The AddBranchByName is used to add a set of response parameters to the response structure according to a multiplexer database definitioxn given by its short name.
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 element(s) to be placed in the newly created multiplexer branch. |
| ShortName | String | Term | - | [1] | The name of the multiplexer branch to be added. |
OTL Examples
DiagCom.Request Request;
DiagCom.ComChannel ComChannel1;
DiagCom.DiagService DiagService1;
DiagCom.Result Result1;
DiagCom.Response Response1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", NULL, false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu");
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
DiagCom.ExecuteDiagService(DiagService1, {}, {}, Result1, NULL, false, false);
Response1 = DiagCom.GetFirstResponse(Result);
Request = DiagCom.GetRequest(DiagService1);
Job.AddBranchByName(Response1, Request, "Read Data By Identifier / Actuator Test Status");See also
SendFinalResult
SendIntermediateResult
SetJobInfo
SetProgressInfo
AddElement
AddBranchByIndex
AddBranchByValue
AddEnvDataByDtc
GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetFirstResponse
GetRequest
