Extensions.Job.AddBranchByIndex

From emotive
Revision as of 05:00, 18 October 2018 by Hb (talk | contribs)
Jump to navigation Jump to search

Classification

Name AddBranchByIndex
Short Description Adds a set of response parameters to the response structure by its index
Class Action
Extension OTX Job extension
Group Job related actions
Exceptions TypeMismatchException
[Core.DataTypes.ComplexDataType.OutOfBoundsException
Checker Rules OutOfBoundsException]]
Standard Compliant Yes

OTL Syntax

Job.AddBranchByIndex(ParameterContainer, ParameterContainer, NumericTerm);

Description

The AddBranchByIndex is used to add a number of parameters Response to Response structure according to a multiplexer database definition given by its index.

Properties

Name Data Type Class Default Cardinality Description
ParameterContainer ParameterContainer Term - [1] The parameter where new element(s) shall be added.
Index Numeric Term - [1] The index of the multiplexer branch to be added. Float values shall be truncated.
Content ParameterContainer Term - [0..1] The element(s) to be placed in the newly created multiplexer branch.

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.AddBranchByIndex(Response1, Request, 1);

See also

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