Extensions.Job.AddBranchByName

From emotive
Revision as of 07:18, 18 October 2018 by Hb (talk | contribs) (→‎OTL Examples)
Jump to navigation Jump to search

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(Result1);
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