Difference between revisions of "Extensions.DiagCom.GetComParameterValueAsString"

From emotive
Jump to navigation Jump to search
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''GetComParameterValueAsString'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetComParameterValueAsString | The current value of a [[String]] communication parameter | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[ComParam related terms]] | [[UnknownTargetException]] <br/> [[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 = DiagCom.GetComParameterValueAsString(ComChannelTerm, StringTerm);
+
StringTerm DiagCom.GetComParameterValueAsString(ComChannelTerm comChannel, StringTerm comParameterName);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetComParameterValueAsString''' term return the current value of a [[String]] communication parameter.
+
The '''GetComParameterValueAsString''' term will 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 will be returned.
  
−
{{TermReturnValue| [[String]] | The current value of a [[String]] communication parameter.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The current value of a [[Core.DataTypes.SimpleDataType.String|String]] communication parameter.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[ComChannel]] | [[Term]] | - | [1] | Communication channel.}}
+
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | The '''ComChannelTerm''' specifies the '''ComChannel''' which will be queried.}}
−
{{TableRowPropertie2| ComParameterName | [[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;
+
/// Local Declarations
−
DiagCom.DiagService DiagService1;
 
−
String String1;
 
  
−
myComCannel = DiagCom.GetComChannel("LL_AirbaUDS", null, false);
+
DiagCom.ComChannel ComChannel1;
−
DiagService1 = DiagCom.CreateDiagServiceByName(myComCannel, "DiagnServi_ReadDataByIdentBasicSettiStatu");
+
String String1 = "";
−
String1 = DiagCom.GetDefaultComParameterValueAsString(myComCannel, "CP_ChangeSpeedCtrl");
+
 
 +
/// 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");
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetComParameterValueAsBoolean]] <br/>
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
−
[[GetComParameterValueAsInteger]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
−
[[GetComParameterValueAsFloat]] <br/>
+
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
−
[[GetComParameterValueAsByteField]] <br/>
+
[[Extensions.DiagCom.GetComplexComParameter|GetComplexComParameter]] <br/>
−
[[GetComParameterValueAsQuantity]]
+
[[Extensions.DiagCom.SetComplexComParameter|SetComplexComParameter]] <br/>
 +
[[Extensions.DiagCom.GetComParameterValueAsBoolean|GetComParameterValueAsBoolean]] <br/>
 +
[[Extensions.DiagCom.GetComParameterValueAsInteger|GetComParameterValueAsInteger]] <br/>
 +
[[Extensions.DiagCom.GetComParameterValueAsFloat|GetComParameterValueAsFloat]] <br/>
 +
[[Extensions.DiagCom.GetComParameterValueAsByteField|GetComParameterValueAsByteField]] <br/>
 +
[[Extensions.DiagCom.GetComParameterValueAsQuantity|GetComParameterValueAsQuantity]]

Latest revision as of 09:49, 24 December 2019

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 comChannel, StringTerm comParameterName);

Description

The GetComParameterValueAsString term will 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 will 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 will be queried.
ComParameterName String Term - [1] The otx:StringTerm specifies the name of a communication parameter.

OTL Examples

/// Local Declarations

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=10275"