Difference between revisions of "Extensions.DiagCom.SetParameterValue"
Jump to navigation
Jump to search
| (10 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''SetParameterValue '''}}[[Category:DiagCom]] | {{DISPLAYTITLE:OTX '''SetParameterValue '''}}[[Category:DiagCom]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | SetParameterValue | Sets | + | {{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 [[Extensions.DiagCom.SetParameterValue|SetParameterValue]] activity sets | + | 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 | [Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | | + | {{TableRowPropertie1| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | This element specifies the parameter which will be set.}} |
| − | {{TableRowPropertie2| Value | - | [[Term]] | - | [1] | | + | {{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;"> | ||
| − | + | /// Local Declarations | |
| − | |||
| − | |||
| − | |||
| − | + | DiagCom.Request Request1; | |
| − | + | DiagCom.Parameter Parameter1; | |
| − | + | ||
| − | + | /// Flow | |
| − | DiagCom.SetParameterValue( | + | |
| + | Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "SinglJob_PostDataSet")); | ||
| + | Parameter1 = DiagCom.GetParameterByPath(Request1, {"IPA_Refer"}); | ||
| + | DiagCom.SetParameterValue(Parameter1, &FFFF); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 35: | Line 35: | ||
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> | [[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> | ||
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/> | [[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/> | ||
| − | [[Extensions.DiagCom. | + | [[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
