Difference between revisions of "Extensions.DiagCom.SetParameterValueBySemantic"
Jump to navigation
Jump to search
| (4 intermediate revisions by one other user not shown) | |||
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | DiagCom.SetParameterValueBySemantic(ParameterContainerTerm, StringTerm, Term); | + | DiagCom.SetParameterValueBySemantic(ParameterContainerTerm parameterContainer, StringTerm semantic, Term value); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 11: | Line 11: | ||
The '''SetParameterValueBySemantic''' activity sets a value to a '''<parameter>''' element with a specific semantic. This action is used in case the | The '''SetParameterValueBySemantic''' activity sets a value to a '''<parameter>''' element with a specific semantic. This action is used in case the | ||
backend communication system provides the means to associate semantic metadata with parameters of diagnostic services. The value to be set is to be provided as an [[Core.DataTypes.SimpleDataType|OTX simple type]], an [[Core.DataTypes.ComplexDataType.ByteField|OTX bytefield]], [[Core.DataTypes.ComplexDataType.List|list]] or [[Core.DataTypes.ComplexDataType.Map|map]] or an OTX [[Extensions.Quantities.Quantity|Quantity]]. | backend communication system provides the means to associate semantic metadata with parameters of diagnostic services. The value to be set is to be provided as an [[Core.DataTypes.SimpleDataType|OTX simple type]], an [[Core.DataTypes.ComplexDataType.ByteField|OTX bytefield]], [[Core.DataTypes.ComplexDataType.List|list]] or [[Core.DataTypes.ComplexDataType.Map|map]] or an OTX [[Extensions.Quantities.Quantity|Quantity]]. | ||
| − | |||
| − | |||
{{Note|When using an ODX/MVCI based system it is mandatory to assign specific semantic attribute values to the parameters used by diagnostic services for implementing DDLID (Dynamically Defined Local Identifier) functionality, like the DDLID-POS semantic attribute that’s used for indicating the parameter that defines the position of a value in a dynamically created response}} | {{Note|When using an ODX/MVCI based system it is mandatory to assign specific semantic attribute values to the parameters used by diagnostic services for implementing DDLID (Dynamically Defined Local Identifier) functionality, like the DDLID-POS semantic attribute that’s used for indicating the parameter that defines the position of a value in a dynamically created response}} | ||
| Line 19: | Line 17: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie2| ParameterContainer | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [1] | The object that contains the parameter that | + | {{TableRowPropertie2| ParameterContainer | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [1] | The object that contains the parameter that will be changed.}} |
| − | {{TableRowPropertie1| Semantic | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | This element specifies the semantic of the parameter that | + | {{TableRowPropertie1| Semantic | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | This element specifies the semantic of the parameter that will be modified.}} |
| − | {{TableRowPropertie2| Value | - | [[Term]] | - | [1] | This element specifies the value that | + | {{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.DiagService DiagService1; | DiagCom.DiagService DiagService1; | ||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
Latest revision as of 10:04, 12 September 2019
Classification
| Name | SetParameterValueBySemantic |
| Short Description | Sets a value to a <parameter> element with a specific semantic |
| Class | Action |
| Extension | OTX DiagCom extension |
| Group | DiagService related actions |
| Exceptions | TypeMismatchException AmbiguousSemanticException OutOfBoundsException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
DiagCom.SetParameterValueBySemantic(ParameterContainerTerm parameterContainer, StringTerm semantic, Term value);Description
The SetParameterValueBySemantic activity sets a value to a <parameter> element with a specific semantic. This action is used in case the backend communication system provides the means to associate semantic metadata with parameters of diagnostic services. The value to be set is to be provided as an OTX simple type, an OTX bytefield, list or map or an OTX Quantity.
When using an ODX/MVCI based system it is mandatory to assign specific semantic attribute values to the parameters used by diagnostic services for implementing DDLID (Dynamically Defined Local Identifier) functionality, like the DDLID-POS semantic attribute that’s used for indicating the parameter that defines the position of a value in a dynamically created response
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ParameterContainer | ParameterContainer | Term | - | [1] | The object that contains the parameter that will be changed. |
| Semantic | String | Term | - | [1] | This element specifies the semantic of the parameter that will be modified. |
| 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.DiagService DiagService1;
DiagCom.ComChannel ComChannel1;
DiagCom.Request Request1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentMeasuValue");
Request1 = DiagCom.GetRequest(DiagService1);
DiagCom.SetParameterValueBySemantic(Request1, "DATA-ID", "Response_On_Event");