Difference between revisions of "Extensions.DiagCom.SetComplexComParameter"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
−
{{DISPLAYTITLE:OTX '''etComplexComParameter'''}}[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''SetComplexComParameter'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | SetComplexComParameter | Setting of complex communication parameters | [[Action]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[ComParameter related actions]] | [[Core.Actions.Throw.Exception.TypeMismatchException|TypeMismatchException]] | - }}
+
{{ClassificationActivity | SetComplexComParameter | Setting of complex communication parameters | [[Action]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Actions|ComParameter related actions]] | [[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.SetComplexComParameter(ComChannelVariable, ParameterTerm);
+
DiagCom.SetComplexComParameter(ComChannelValue, ParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The OTX '''SetComplexComParameter''' action is an enhanced variant of SetComParameter. The difference between these actions is that in this case complex data types can be used.  
+
The OTX '''SetComplexComParameter''' action is an enhanced variant of '''SetComParameter'''. The difference between these actions is that in this case complex data types can be used.  
−
{{Note|In an ODX/MVCI based '''Diagnostic Runtime System''' complex communication parameters to define lists of response IDs required for functional addressing.}}
+
{{Note|In an ODX/MVCI based system, complex communication parameter data types are used to define response ID lists for the functional addressing use case.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Value]] | - | [1] | This element comprises the communication channel where the communication parameter shall be modified.}}
−
{{TableRowPropertie2| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [0..1] | Structure of the parameter to be changed Communication Saving Meters.}}
+
{{TableRowPropertie2| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | This element comprises the parameter structure which shall be set.}}
 
|}
 
|}
  
 
== 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;
+
DiagCom.ComChannel ComChannel1;
−
DiagCom.Request req;
+
DiagCom.Parameter Parameter1;
−
DiagCom.Parameter param;
 
  
−
myComCannel = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", null, false);
+
/// Flow
−
req = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(myComCannel, "DiagnServi_ReadDataByIdentActuaTestStatu"));
+
 
−
param = DiagCom.GetParameterByPath(req, {"Param_RequeServiId"});
+
ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
−
DiagCom.SetComplexComParameter(myComCannel, param);
+
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, NULL, NULL, false, false);
 +
Parameter1 = DiagCom.GetComplexComParameter(ComChannel1, "CP_TesterPresentMessage");
 +
DiagCom.SetParameterValue(Parameter1, &AAAA);
 +
DiagCom.SetComplexComParameter(ComChannel1, Parameter1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
 
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
−
[[Extensions.DiagCom.SetComParameter|SetComParameter]]
+
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetComplexComParameter|GetComplexComParameter]] <br/>
 +
[[Extensions.DiagCom.SetParameterValue|SetParameterValue]]

Revision as of 10:18, 10 October 2018

Classification

Name SetComplexComParameter
Short Description Setting of complex communication parameters
Class Action
Extension OTX DiagCom extension
Group ComParameter related actions
Exceptions TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

DiagCom.SetComplexComParameter(ComChannelValue, ParameterTerm);

Description

The OTX SetComplexComParameter action is an enhanced variant of SetComParameter. The difference between these actions is that in this case complex data types can be used.

Icons Note.png In an ODX/MVCI based system, complex communication parameter data types are used to define response ID lists for the functional addressing use case.

Properties

Name Data Type Class Default Cardinality Description
ComChannel ComChannel Value - [1] This element comprises the communication channel where the communication parameter shall be modified.
Parameter Parameter Term - [1] This element comprises the parameter structure which shall be set.

OTL Examples

DiagCom.ComChannel ComChannel1;
DiagCom.Parameter Parameter1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, NULL, NULL, false, false);
Parameter1 = DiagCom.GetComplexComParameter(ComChannel1, "CP_TesterPresentMessage");
DiagCom.SetParameterValue(Parameter1, &AAAA);
DiagCom.SetComplexComParameter(ComChannel1, Parameter1);

See also

GetComChannel
ExecuteDiagService
GetComplexComParameter
SetParameterValue

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