Difference between revisions of "Extensions.Job.AddEnvDataByDtc"

From emotive
Jump to navigation Jump to search
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
{{DISPLAYTITLE:  '''AddEnvDataByDtc'''}}
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | AddEnvDataByDtc | Adds environment-data parameter structure | [[Action]] | [[Job|OTX Job extension]] | [[Job related actions]] | [[InvalidParameterizationException]] | - }}
+
{{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(ParameterContainer, IntegerTerm);
+
Job.AddEnvDataByDtc(ParameterContainerTerm parameterContainer, NumericTerm dtc);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
'''AddEnvDataByDtc''' is used to add structure to response according to the value of a DTC an Environment-data parameter structure.
+
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 | [[ParameterContainer]] | [[Term]] | - | [1] | The parameters in which new element (s) to be added.}}
+
{{TableRowPropertie1| ParameterContainer | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [1] | The parameter where new element(s) will be added.}}
−
{{TableRowPropertie2| Dtc | [[Integer]] | [[Term]] | - | [1] | The value of the DTC for the environment data structures to be added}}
+
{{TableRowPropertie2| Dtc | [[Numeric]] | [[Term]] | - | [1] | The value of the DTC for which environment data structures will be added. [[Core.DataTypes.SimpleDataType.Float|Float]] values will 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.Request ParameterContainer1;
+
/// Local Declarations
  
−
Job.AddEnvDataByDtc(ParameterContainer1, 0);
+
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);
 
</syntaxhighlight>
 
</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/>
−
[[AddBranchByName]]<br/>
+
[[Extensions.Job.AddBranchByName|AddBranchByName]]<br/>
−
[[AddBranchByValue]]<br/>
+
[[Extensions.Job.AddBranchByIndex|AddBranchByIndex]]<br/>
−
[[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/>

Latest revision as of 03:27, 13 September 2019

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 parameterContainer, NumericTerm dtc);

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) will be added.
Dtc Numeric Term - [1] The value of the DTC for which environment data structures will be added. Float values will be truncated.

OTL Examples

/// Local Declarations

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

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