OTX Reference  
OpenTestSystem.Otx.Extensions.DiagCom.Actions.SetParameterValueBySemantic Class Reference

Sets the Request-Parameter by semantic attribute More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.DiagCom.Actions.SetParameterValueBySemantic:
Inheritance graph

Public Attributes

ParameterContainerTerm parameterContainer
 Parameter container contains the Parameter to be retrieved. More...
 
StringTerm semantic
 The semantic attribute of the diagnostic service to be created. Please note, that the communication channel (ComChannel) must be selected before you can adjust this value. More...
 
Term value
 Specifies the value that should be set to the Parameter. Allowed input types are simple types, List, Map and Quantity. More...
 
- Public Attributes inherited from OpenTestSystem.Otx.Core.Actions.ActionRealisation
OtxLink validFor
 Validity of ActionRealisation. More...
 

Detailed Description

Sets the Request-Parameter by semantic attribute

The SetParameterValueBySemantic activity sets a value to a Parameter element with a specific semantic attribute. 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 a simple type, a List, Map or 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.
Exceptions
Exceptions.AmbiguousSemanticExceptionIt is thrown if there are none or more than one parameters present in the ParameterContainerTerm with the semantic value specified by the <semantic> element.
Core.Exceptions.OutOfBoundsExceptionIt is thrown if the conversion cannot be made because the OTX value exceeds the limits of the target data type of a parameter of the vehicle communication component.
Core.Exceptions.TypeMismatchExceptionIt is thrown if the data type of the OTX value to be set does not match the parameter vehicle communication component.For instance, it is thrown if a String variable is mapped onto an Integer-type parameter.
Syntax
DiagCom.SetParameterValueBySemantic(ParameterContainerTerm parameterContainer, StringTerm semantic, Term value);
ParameterContainerTerm parameterContainer
Parameter container contains the Parameter to be retrieved.
Definition: DiagCom.cs:1732
StringTerm semantic
The semantic attribute of the diagnostic service to be created. Please note, that the communication c...
Definition: DiagCom.cs:1742
Term value
Specifies the value that should be set to the Parameter. Allowed input types are simple types,...
Definition: DiagCom.cs:1752
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");

Member Data Documentation

◆ parameterContainer

ParameterContainerTerm OpenTestSystem.Otx.Extensions.DiagCom.Actions.SetParameterValueBySemantic.parameterContainer

Parameter container contains the Parameter to be retrieved.

◆ semantic

StringTerm OpenTestSystem.Otx.Extensions.DiagCom.Actions.SetParameterValueBySemantic.semantic

The semantic attribute of the diagnostic service to be created. Please note, that the communication channel (ComChannel) must be selected before you can adjust this value.

◆ value

Term OpenTestSystem.Otx.Extensions.DiagCom.Actions.SetParameterValueBySemantic.value

Specifies the value that should be set to the Parameter. Allowed input types are simple types, List, Map and Quantity.