Difference between revisions of "Extensions.DiagCom.GetComParameterValueAsString"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetComParameterValueAsString'''}}[[Category:DiagCom]]
 
{{DISPLAYTITLE:OTX '''GetComParameterValueAsString'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetComParameterValueAsString | The current value of a [[Core.DataTypes.SimpleDataType.String|String]] communication parameter | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[ComParam related terms]] | [[Core.Actions.Throw.Exception.UnknownTargetException|UnknownTargetException]] <br/> [[Core.Actions.Throw.Exception.TypeMismatchException|TypeMismatchException]] | - }}
+
{{ClassificationActivity | GetComParameterValueAsString | Gets the current value of a [[Core.DataTypes.SimpleDataType.String|String]] communication parameter | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|ComParam related terms]] | [[Extensions.DiagCom.UnknownTargetException|UnknownTargetException]] <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;">
−
StringTerm = Extensions.DiagCom.GetComParameterValueAsString(ComChannelTerm, StringTerm);
+
StringTerm = DiagCom.GetComParameterValueAsString(ComChannelTerm, StringTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetComParameterValueAsString''' term return the current value of a [[Core.DataTypes.SimpleDataType.String|String]] communication parameter.
+
The '''GetComParameterValueAsString''' term comprises the '''ChannelAndParameterName''' attribute group and shall return the current value of a [[Core.DataTypes.SimpleDataType.String|string]] type communication parameter. If the communication parameter has not been previously modified by the [[Extensions.DiagCom.SetComParameter|SetComParameter]] action, the default parameter value shall be returned.
  
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The current value of a [[Core.DataTypes.SimpleDataType.String|String]] communication parameter.}}
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The current value of a [[Core.DataTypes.SimpleDataType.String|String]] communication parameter.}}
Line 16: Line 16:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | Communication channel.}}
+
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | The '''ComChannelTerm''' specifies the '''ComChannel''' which shall be queried.}}
−
{{TableRowPropertie2| ComParameterName | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Name of communication channel.}}
+
{{TableRowPropertie2| ComParameterName | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The '''otx:StringTerm''' specifies the name of a communication parameter.}}
 
|}
 
|}
  
 
== 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.DiagService DiagService1;
+
String String1 = "";
−
String String1;
 
  
−
myComCannel = DiagCom.GetComChannel("LL_AirbaUDS", null, false);
+
/// Flow
−
DiagService1 = DiagCom.CreateDiagServiceByName(myComCannel, "DiagnServi_ReadDataByIdentBasicSettiStatu");
+
 
−
String1 = DiagCom.GetDefaultComParameterValueAsString(myComCannel, "CP_ChangeSpeedCtrl");
+
ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
 +
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
 +
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, NULL, NULL, false, false);
 +
String1 = DiagCom.GetComParameterValueAsString(ComChannel1, "CP_ModifyTiming");
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetComplexComParameter|GetComplexComParameter]] <br/>
 +
[[Extensions.DiagCom.SetComplexComParameter|SetComplexComParameter]] <br/>
 
[[Extensions.DiagCom.GetComParameterValueAsBoolean|GetComParameterValueAsBoolean]] <br/>
 
[[Extensions.DiagCom.GetComParameterValueAsBoolean|GetComParameterValueAsBoolean]] <br/>
 
[[Extensions.DiagCom.GetComParameterValueAsInteger|GetComParameterValueAsInteger]] <br/>
 
[[Extensions.DiagCom.GetComParameterValueAsInteger|GetComParameterValueAsInteger]] <br/>

Revision as of 08:53, 15 October 2018

Classification

Name GetComParameterValueAsString
Short Description Gets the current value of a String communication parameter
Class Term
Extension OTX DiagCom extension
Group ComParam related terms
Exceptions UnknownTargetException
TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm = DiagCom.GetComParameterValueAsString(ComChannelTerm, StringTerm);

Description

The GetComParameterValueAsString term comprises the ChannelAndParameterName attribute group and shall return the current value of a string type communication parameter. If the communication parameter has not been previously modified by the SetComParameter action, the default parameter value shall be returned.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
String The current value of a String communication parameter.

Properties

Name Data Type Class Default Cardinality Description
ComChannel ComChannel Term - [1] The ComChannelTerm specifies the ComChannel which shall be queried.
ComParameterName String Term - [1] The otx:StringTerm specifies the name of a communication parameter.

OTL Examples

DiagCom.ComChannel ComChannel1;
String String1 = "";

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, NULL, NULL, false, false);
String1 = DiagCom.GetComParameterValueAsString(ComChannel1, "CP_ModifyTiming");

See also

GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetComplexComParameter
SetComplexComParameter
GetComParameterValueAsBoolean
GetComParameterValueAsInteger
GetComParameterValueAsFloat
GetComParameterValueAsByteField
GetComParameterValueAsQuantity

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