Difference between revisions of "Extensions.DiagCom.SetParameterValue"

From emotive
Jump to navigation Jump to search
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''SetParameterValue '''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | SetParameterValue | Sets the value of a request parameter | [[Action]] | [[DiagCom|OTX DiagCom extension]] | [[DiagService related actions]] | [[OutOfBoundsException]] <br/> [[TypeMismatchException]] | - }}
+
{{ClassificationActivity | SetParameterValue | Sets a specific value to a '''Parameter''' element | [[Action]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[DiagService related actions]] | [[Core.DataTypes.ComplexDataType.OutOfBoundsException|OutOfBoundsException]] <br/> [[Core.DataTypes.ComplexDataType.TypeMismatchException|TypeMismatchException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.SetParameterValue(ParameterTerm, Term);
+
DiagCom.SetParameterValue(ParameterTerm parameter, Term value);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The OTX [[SetParameterValue]] activity sets the value of a request parameter "manually" to a specific value, see [[ExecuteDiagService]].  
+
The OTX [[Extensions.DiagCom.SetParameterValue|SetParameterValue]] activity sets a specific value to a [[Extensions.DiagCom.Parameter|Parameter]] element. The value to be set is to be provided as an [[Core.DataTypes.SimpleDataType|OTX simple type]], an OTX [[Core.DataTypes.ComplexDataType.List|lists]] or [[Core.DataTypes.ComplexDataType.Map|maps]] or an OTX [[Extensions.Quantities.Quantity|Quantity]]
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Parameter | [[Parameter]] | [[Term]] | - | [1] | Request parameter whose value is to be set.}}
+
{{TableRowPropertie1| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | This element specifies the parameter which will be set.}}
−
{{TableRowPropertie2| Value | - | [[Term]] | - | [1] | Value of the corresponding type that is to be placed.}}
+
{{TableRowPropertie2| Value | - | [[Term]] | - | [1] | This element specifies the value that will be set to the Parameter. Allowed input types are [[Core.DataTypes.SimpleDataType|OTX simple types]], [[Core.DataTypes.ComplexDataType.ByteField|OTX bytefields]], [[Core.DataTypes.ComplexDataType.List|lists]] and [[Core.DataTypes.ComplexDataType.Map|maps]] and [[Extensions.Quantities.Quantity|OTX quantities]].}}
 
|}
 
|}
  
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.ComChannel myComCannel;
+
/// Local Declarations
−
DiagCom.DiagService myDiagService;
 
−
DiagCom.Request req;
 
−
DiagCom.Parameter param;
 
  
−
myComCannel = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", null, false);
+
DiagCom.Request Request1;
−
myDiagService = DiagCom.CreateDiagServiceByName(myComCannel, "DiagnServi_ReadDataByIdentASAMODXFileIdent");
+
DiagCom.Parameter Parameter1;
−
req = DiagCom.GetRequest(myDiagService);
+
 
−
param = DiagCom.GetParameterByPath(req, {"Param_RecorDataIdent"});
+
/// Flow
−
DiagCom.SetParameterValue(param, 123);
+
 
 +
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "SinglJob_PostDataSet"));
 +
Parameter1 = DiagCom.GetParameterByPath(Request1, {"IPA_Refer"});
 +
DiagCom.SetParameterValue(Parameter1, &FFFF);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetComChannel]] <br/>
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
−
[[CreateDiagServiceByName]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
−
[[SetParameterValueBySemantic]]
+
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]]<br/>
 +
[[Extensions.DiagCom.GetRequest|GetRequest]]<br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]]

Latest revision as of 02:38, 11 December 2019

Classification

Name SetParameterValue
Short Description Sets a specific value to a Parameter element
Class Action
Extension OTX DiagCom extension
Group DiagService related actions
Exceptions OutOfBoundsException
TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

DiagCom.SetParameterValue(ParameterTerm parameter, Term value);

Description

The OTX SetParameterValue activity sets a specific value to a Parameter element. The value to be set is to be provided as an OTX simple type, an OTX lists or maps or an OTX Quantity

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1] This element specifies the parameter which will be set.
Value - Term - [1] This element specifies the value that will be set to the Parameter. Allowed input types are OTX simple types, OTX bytefields, lists and maps and OTX quantities.

OTL Examples

/// Local Declarations

DiagCom.Request Request1;
DiagCom.Parameter Parameter1;

/// Flow

Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "SinglJob_PostDataSet"));
Parameter1 = DiagCom.GetParameterByPath(Request1, {"IPA_Refer"});
DiagCom.SetParameterValue(Parameter1, &FFFF);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetRequest
GetParameterByPath

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.DiagCom.SetParameterValue&oldid=10270"