Difference between revisions of "Extensions.Job.AddEnvDataByDtc"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | {{DISPLAYTITLE: '''AddEnvDataByDtc '''}} | + | {{DISPLAYTITLE: '''AddEnvDataByDtc'''}} |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | AddEnvDataByDtc | Adds environment | + | {{ClassificationActivity | AddEnvDataByDtc | Adds an environment data parameter structure to the response structure | [[Action]] | [[Extensions.Job|OTX Job extension]] | [[Extensions.Job#Actions|Job related actions]] | [[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.AddEnvDataByDtc( | + | Job.AddEnvDataByDtc(ParameterContainerTerm, NumericTerm); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | '''AddEnvDataByDtc''' is used to add structure to response according to the value of a DTC | + | The '''AddEnvDataByDtc''' is used to add an environment data parameter structure to the response structure according to the value of a DTC. |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ParameterContainer | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [1] | The | + | {{TableRowPropertie1| ParameterContainer | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [1] | The parameter where new element(s) shall be added.}} |
| − | {{TableRowPropertie2| Dtc | [[ | + | {{TableRowPropertie2| Dtc | [[Numeric]] | [[Term]] | - | [1] | The value of the DTC for which environment data structures shall be added. [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | DiagCom. | + | DiagCom.ComChannel ComChannel1; |
| + | DiagCom.DiagService DiagService1; | ||
| + | DiagCom.Result Result1; | ||
| + | DiagCom.Response Response1; | ||
| − | Job.AddEnvDataByDtc( | + | /// Flow |
| + | |||
| + | ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false); | ||
| + | DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDTCInforReporDTCExtenDataRecorByDTCNumbe"); | ||
| + | [#MetaData(RequestPdu), <#Data>19 06 00 00 0D 01</#Data>] | ||
| + | DiagCom.ExecuteDiagService(DiagService1, {Param_DTCMaskRecorGroupOfDTC = 13, Param_DTCExtenDataRecorNumbe = "Standard DTC Information"}, {}, Result1, NULL, false, false); | ||
| + | Response1 = DiagCom.GetFirstResponse(Result1); | ||
| + | Job.AddEnvDataByDtc(Response1, 4); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 33: | Line 43: | ||
[[Extensions.Job.AddBranchByName|AddBranchByName]]<br/> | [[Extensions.Job.AddBranchByName|AddBranchByName]]<br/> | ||
[[Extensions.Job.AddBranchByIndex|AddBranchByIndex]]<br/> | [[Extensions.Job.AddBranchByIndex|AddBranchByIndex]]<br/> | ||
| − | [[Extensions.Job.AddBranchByValue|AddBranchByValue]] | + | [[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/> | ||
Revision as of 08:06, 18 October 2018
Classification
| Name | AddEnvDataByDtc |
| Short Description | Adds an environment data parameter structure to the response structure |
| Class | Action |
| Extension | OTX Job extension |
| Group | Job related actions |
| Exceptions | InvalidParameterizationException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
Job.AddEnvDataByDtc(ParameterContainerTerm, NumericTerm);Description
The AddEnvDataByDtc is used to add an environment data parameter structure to the response structure according to the value of a DTC.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ParameterContainer | ParameterContainer | Term | - | [1] | The parameter where new element(s) shall be added. |
| Dtc | Numeric | Term | - | [1] | The value of the DTC for which environment data structures shall be added. Float values shall be truncated. |
OTL Examples
DiagCom.ComChannel ComChannel1;
DiagCom.DiagService DiagService1;
DiagCom.Result Result1;
DiagCom.Response Response1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDTCInforReporDTCExtenDataRecorByDTCNumbe");
[#MetaData(RequestPdu), <#Data>19 06 00 00 0D 01</#Data>]
DiagCom.ExecuteDiagService(DiagService1, {Param_DTCMaskRecorGroupOfDTC = 13, Param_DTCExtenDataRecorNumbe = "Standard DTC Information"}, {}, Result1, NULL, false, false);
Response1 = DiagCom.GetFirstResponse(Result1);
Job.AddEnvDataByDtc(Response1, 4);See also
SendFinalResult
SendIntermediateResult
SetJobInfo
SetProgressInfo
AddElement
AddBranchByName
AddBranchByIndex
AddBranchByValue
GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetFirstResponse
GetRequest
