Difference between revisions of "Extensions.Job.AddEnvDataByDtc"

From emotive
Jump to navigation Jump to search
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 environment-data parameter structure | [[Action]] | [[Extensions.Job|OTX Job extension]] | [[Job related actions]] | [[Extensions.Job.InvalidParameterizationException|InvalidParameterizationException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 13: Line 14:
 
{| {{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 parameters in which new element (s) to be added.}}
{{TableRowPropertie2| Dtc | [[Integer]] | [[Term]] | - | [1] | The value of the DTC for the environment data structures to be added}}
+
{{TableRowPropertie2| Dtc | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | The value of the DTC for the environment data structures to be added}}
 
|}
 
|}
  
Line 25: Line 26:
  
 
== 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]]

Revision as of 10:39, 15 February 2016

Classification

Name AddEnvDataByDtc
Short Description Adds environment-data parameter structure
Class Action
Extension OTX Job extension
Group Job related actions
Exceptions InvalidParameterizationException
Checker Rules -
Standard Compliant Yes

OTL Syntax

Job.AddEnvDataByDtc(ParameterContainer, IntegerTerm);

Description

AddEnvDataByDtc is used to add structure to response according to the value of a DTC an Environment-data parameter structure.

Properties

Name Data Type Class Default Cardinality Description
ParameterContainer ParameterContainer Term - [1] The parameters in which new element (s) to be added.
Dtc Integer Term - [1] The value of the DTC for the environment data structures to be added

OTL Examples

DiagCom.Request ParameterContainer1;

Job.AddEnvDataByDtc(ParameterContainer1, 0);

See also

SendFinalResult
SendIntermediateResult
SetJobInfo
SetProgressInfo
AddElement
AddBranchByName
AddBranchByIndex
AddBranchByValue