Difference between revisions of "Extensions.DiagCom.GetComParameterValueAsString"
Jump to navigation
Jump to search
m (Hb moved page GetComParameterValueAsString to Extensions.DiagCom.GetComParameterValueAsString: #3153) |
|||
| 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 | The current value of a [[Core.DataTypes.SimpleDataType.String|String]] communication parameter | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[ComParam related terms]] | [[Extensions.DiagCom.UnknownTargetException|UnknownTargetException]] <br/> [[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 = Extensions.DiagCom.GetComParameterValueAsString(ComChannelTerm, StringTerm); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetComParameterValueAsString''' term return the current value of a [[String]] communication parameter. | + | The '''GetComParameterValueAsString''' term return the current value of a [[Core.DataTypes.SimpleDataType.String|String]] communication parameter. |
| − | {{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] | Communication channel.}} |
| − | {{TableRowPropertie2| ComParameterName | [[String]] | [[Term]] | - | [1] | Name of communication channel.}} | + | {{TableRowPropertie2| ComParameterName | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Name of communication channel.}} |
|} | |} | ||
| Line 32: | Line 32: | ||
== See also == | == See also == | ||
| − | [[GetComParameterValueAsBoolean]] <br/> | + | [[Extensions.DiagCom.GetComParameterValueAsBoolean|GetComParameterValueAsBoolean]] <br/> |
| − | [[GetComParameterValueAsInteger]] <br/> | + | [[Extensions.DiagCom.GetComParameterValueAsInteger|GetComParameterValueAsInteger]] <br/> |
| − | [[GetComParameterValueAsFloat]] <br/> | + | [[Extensions.DiagCom.GetComParameterValueAsFloat|GetComParameterValueAsFloat]] <br/> |
| − | [[GetComParameterValueAsByteField]] <br/> | + | [[Extensions.DiagCom.GetComParameterValueAsByteField|GetComParameterValueAsByteField]] <br/> |
| − | [[GetComParameterValueAsQuantity]] | + | [[Extensions.DiagCom.GetComParameterValueAsQuantity|GetComParameterValueAsQuantity]] |
Revision as of 03:19, 15 February 2016
Contents
Classification
| Name | GetComParameterValueAsString |
| Short Description | 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 = Extensions.DiagCom.GetComParameterValueAsString(ComChannelTerm, StringTerm);Description
The GetComParameterValueAsString term return the current value of a String communication parameter.
Return Value
The Term returns the value, see table below.
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] | Communication channel. |
| ComParameterName | String | Term | - | [1] | Name of communication channel. |
OTL Examples
DiagCom.ComChannel myComCannel;
DiagCom.DiagService DiagService1;
String String1;
myComCannel = DiagCom.GetComChannel("LL_AirbaUDS", null, false);
DiagService1 = DiagCom.CreateDiagServiceByName(myComCannel, "DiagnServi_ReadDataByIdentBasicSettiStatu");
String1 = DiagCom.GetDefaultComParameterValueAsString(myComCannel, "CP_ChangeSpeedCtrl");See also
GetComParameterValueAsBoolean
GetComParameterValueAsInteger
GetComParameterValueAsFloat
GetComParameterValueAsByteField
GetComParameterValueAsQuantity
