Difference between revisions of "Extensions.DiagCom.SetParameterValueBySemantic"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''SetParameterValueBySemantic'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | SetParameterValueBySemantic | Sets the value of a request parameter via a semantic attribute | [[Action]] | [[DiagCom|OTX DiagCom extension]] | [[ComParameter related actions]] | [[TypeMismatchException]] <br/> [[AmbiguousSemanticException]] <br/> [[OutOfBoundsException]] | - }}
+
{{ClassificationActivity | SetParameterValueBySemantic | Sets the value of a request parameter via a semantic attribute | [[Action]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[ComParameter related actions]] | [[TypeMismatchException]] <br/> [[Extensions.DiagCom.AmbiguousSemanticException|AmbiguousSemanticException]] <br/> [[OutOfBoundsException]] | - }}
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Line 8: Line 8:
  
 
== Description ==
 
== Description ==
The '''SetParameterValueBySemantic''' activity sets a request parameter "manually" to a specific value, see [[ExecuteDiagService]]. The parameter is used on a so-called semantic-attribute selected.  
+
The '''SetParameterValueBySemantic''' activity sets a request parameter "manually" to a specific value, see [[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]]. The parameter is used on a so-called semantic-attribute selected.  
 
{{Note|Is a prerequisite for the use of semantic attributes, that they through the diagnostic runtime system are supported and that they in the diagnostic database have been adjusted.}}
 
{{Note|Is a prerequisite for the use of semantic attributes, that they through the diagnostic runtime system are supported and that they in the diagnostic database have been adjusted.}}
  
Line 14: Line 14:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ParameterContainer | [[ParameterContainer]] | [[Term]] | - | [1] | The object that contains the parameter whose to be set value.}}
+
{{TableRowPropertie1| ParameterContainer | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [1] | The object that contains the parameter whose to be set value.}}
{{TableRowPropertie2| Semantic | [[String]] | [[Term]] | - | [1] | Semantics attribute.}}
+
{{TableRowPropertie2| Semantic | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Semantics attribute.}}
 
{{TableRowPropertie1| Value | - | [[Variable]] | - | [1] | Value of the corresponding type that is to be placed.}}
 
{{TableRowPropertie1| Value | - | [[Variable]] | - | [1] | Value of the corresponding type that is to be placed.}}
 
|}
 
|}
Line 34: Line 34:
  
 
== See also ==
 
== See also ==
[[GetComChannel]] <br/>
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
[[SetParameterValue]] <br/>
+
[[Extensions.DiagCom.SetParameterValue|SetParameterValue]] <br/>
[[SetPdu]]
+
[[Extensions.DiagCom.SetPdu|SetPdu]]

Revision as of 08:41, 5 February 2016

Classification

Name SetParameterValueBySemantic
Short Description Sets the value of a request parameter via a semantic attribute
Class Action
Extension OTX DiagCom extension
Group ComParameter related actions
Exceptions TypeMismatchException
AmbiguousSemanticException
OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

DiagCom.SetParameterValueByPath(ParameterContainer, StringTerm, Term);

Description

The SetParameterValueBySemantic activity sets a request parameter "manually" to a specific value, see ExecuteDiagService. The parameter is used on a so-called semantic-attribute selected.

Icons Note.png Is a prerequisite for the use of semantic attributes, that they through the diagnostic runtime system are supported and that they in the diagnostic database have been adjusted.

Properties

Name Data Type Class Default Cardinality Description
ParameterContainer ParameterContainer Term - [1] The object that contains the parameter whose to be set value.
Semantic String Term - [1] Semantics attribute.
Value - Variable - [1] Value of the corresponding type that is to be placed.

OTL Examples

DiagCom.ComChannel myComCannel;
DiagCom.DiagService myDiagService;
DiagCom.Request req;
DiagCom.Parameter param;

myComCannel = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", null, false);
myDiagService = DiagCom.CreateDiagServiceByName(myComCannel, "DiagnServi_ReadDataByIdentASAMODXFileIdent");
req = DiagCom.GetRequest(myDiagService);
param = DiagCom.GetParameterByPath(req, {"Param_RecorDataIdent"});
DiagCom.SetParameterValueBySemantic(param, "Semantic", "Value");

See also

GetComChannel
SetParameterValue
SetPdu