Difference between revisions of "Extensions.DiagCom.GetDefaultComParameterValueAsString"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''GetDefaultComParameterValueAsString'''}}[[Category:DiagCom]] | {{DISPLAYTITLE:OTX '''GetDefaultComParameterValueAsString'''}}[[Category:DiagCom]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetDefaultComParameterValueAsString | The | + | {{ClassificationActivity | GetDefaultComParameterValueAsString | Gets The default 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 == | ||
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | The '''GetDefaultComParameterValueAsString''' term return the default value of a [[Core.DataTypes.SimpleDataType.String| | + | The '''GetDefaultComParameterValueAsString''' term comprises the '''ChannelAndParameterName''' attribute group and shall return the default value of a [[Core.DataTypes.SimpleDataType.String|string]] type communication parameter. |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The default value of a [[Core.DataTypes.SimpleDataType.String|String]] communication parameter.}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The default 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] | | + | {{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] | | + | {{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 | + | DiagCom.ComChannel ComChannel1; |
| − | + | String String1 = ""; | |
| − | String String1; | ||
| − | + | /// Flow | |
| − | + | ||
| − | String1 = DiagCom.GetDefaultComParameterValueAsString( | + | ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false); |
| + | String1 = DiagCom.GetDefaultComParameterValueAsString(ComChannel1, "CP_ModifyTiming"); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| + | [[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> | ||
| + | [[Extensions.DiagCom.GetComplexComParameter|GetComplexComParameter]] <br/> | ||
| + | [[Extensions.DiagCom.SetComplexComParameter|SetComplexComParameter]] <br/> | ||
[[Extensions.DiagCom.GetDefaultComParameterValueAsBoolean|GetDefaultComParameterValueAsBoolean]] <br/> | [[Extensions.DiagCom.GetDefaultComParameterValueAsBoolean|GetDefaultComParameterValueAsBoolean]] <br/> | ||
[[Extensions.DiagCom.GetDefaultComParameterValueAsInteger|GetDefaultComParameterValueAsInteger]] <br/> | [[Extensions.DiagCom.GetDefaultComParameterValueAsInteger|GetDefaultComParameterValueAsInteger]] <br/> | ||
Revision as of 10:11, 15 October 2018
Contents
Classification
| Name | GetDefaultComParameterValueAsString |
| Short Description | Gets The default 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.GetDefaultComParameterValueAsString(ComChannelTerm, StringTerm);Description
The GetDefaultComParameterValueAsString term comprises the ChannelAndParameterName attribute group and shall return the default value of a string type 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 default 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);
String1 = DiagCom.GetDefaultComParameterValueAsString(ComChannel1, "CP_ModifyTiming");See also
GetComChannel
GetComplexComParameter
SetComplexComParameter
GetDefaultComParameterValueAsBoolean
GetDefaultComParameterValueAsInteger
GetDefaultComParameterValueAsFloat
GetDefaultComParameterValueAsByteField
GetDefaultComParameterValueAsQuantity
