Difference between revisions of "Extensions.Job.AddBranchByName"

From emotive
Jump to navigation Jump to search
(Created page with "== Classification == {{ClassificationActivity | AddBranchByName | Adds a set of response parameters with short name | Action | OTX Job extension | Job related ac...")
 
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{DISPLAYTITLE:  '''AddBranchByName '''}}
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | AddBranchByName | Adds a set of response parameters with short name | [[Action]] | [[Job|OTX Job extension]] | [[Job related actions]] | [[TypeMismatchException]]<br/>[[InvalidParameterizationException]] | - }}
+
{{ClassificationActivity | AddBranchByName | Adds a set of response parameters with short name | [[Action]] | [[Extensions.Job|OTX Job extension]] | [[Extensions.Job#Actions|Job related actions]] | [[Core.DataTypes.ComplexDataType.TypeMismatchException|TypeMismatchException]]<br/>[[Extensions.Job.InvalidParameterizationException|InvalidParameterizationException]] | - }}
 +
 
 +
== OTL Syntax ==
 +
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
Job.AddBranchByName(ParameterContainerTerm parameterContainer, ParameterContainerTerm content, StringTerm shortName);
 +
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
'''AddBranchByName''' is used to add a number of parameters '''Response''' to '''Response''' structure according to the definition of a multiplexer database by its short name.
+
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}}
−
{{TableRowPropertie1| ParameterContainer | [[ParameterContainer]] | [[Term]] | - | [1] | The parameters in which new element (s) to be added.}}
+
{{TableRowPropertie2| ParameterContainer | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [1] | The parameters in which new element (s) to be added.}}
−
{{TableRowPropertie2| Content | [[ParameterContainer]] | [[Term]] | - | [0..1] | The element that is placed in the newly created branch multiplexer.}}
+
{{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 ==
 +
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
/// 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.AddBranchByName(Response1, Parameter1, "Read Data By Identifier / Actuator Test Status");
 +
</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/>
−
[[AddElement]]<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:40, 7 November 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 parameterContainer, ParameterContainerTerm content, StringTerm shortName);

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

/// 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.AddBranchByName(Response1, Parameter1, "Read Data By Identifier / Actuator Test Status");

See also

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

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.Job.AddBranchByName&oldid=9095"