Difference between revisions of "Extensions.DiagCom.GetDefaultComParameterValueAsString"
Jump to navigation
Jump to search
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[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 == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | StringTerm DiagCom.GetDefaultComParameterValueAsString(ComChannelTerm comChannel, StringTerm comParameterName); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetDefaultComParameterValueAsString''' term return the default value of a [[String]] communication parameter. | + | The '''GetDefaultComParameterValueAsString''' term will return the default value of a [[Core.DataTypes.SimpleDataType.String|string]] type communication parameter. |
| − | {{TermReturnValue| [[String]] | The default value of a [[String]] communication parameter.}} | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The default value of a [[Core.DataTypes.SimpleDataType.String|String]] communication parameter.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ComChannel | [[ComChannel]] | [[Term]] | - | [1] | | + | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | The '''ComChannelTerm''' specifies the '''ComChannel''' which will be queried.}} |
| − | {{TableRowPropertie2| ComParameterName | [[String]] | [[Term]] | - | [1] | | + | {{TableRowPropertie2| ComParameterName | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The '''otx:StringTerm''' specifies the name of a communication parameter.}} |
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | String | + | /// Local Declarations |
| + | |||
| + | DiagCom.ComChannel ComChannel1; | ||
| + | String String1 = ""; | ||
| + | |||
| + | /// Flow | ||
| + | |||
| + | ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false); | ||
| + | String1 = DiagCom.GetDefaultComParameterValueAsString(ComChannel1, "CP_ModifyTiming"); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[GetDefaultComParameterValueAsBoolean]] <br/> | + | [[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> |
| − | [[GetDefaultComParameterValueAsInteger]] <br/> | + | [[Extensions.DiagCom.GetComplexComParameter|GetComplexComParameter]] <br/> |
| − | [[GetDefaultComParameterValueAsFloat]] <br/> | + | [[Extensions.DiagCom.SetComplexComParameter|SetComplexComParameter]] <br/> |
| − | [[GetDefaultComParameterValueAsByteField]] <br/> | + | [[Extensions.DiagCom.GetDefaultComParameterValueAsBoolean|GetDefaultComParameterValueAsBoolean]] <br/> |
| − | [[GetDefaultComParameterValueAsQuantity]] | + | [[Extensions.DiagCom.GetDefaultComParameterValueAsInteger|GetDefaultComParameterValueAsInteger]] <br/> |
| + | [[Extensions.DiagCom.GetDefaultComParameterValueAsFloat|GetDefaultComParameterValueAsFloat]] <br/> | ||
| + | [[Extensions.DiagCom.GetDefaultComParameterValueAsByteField|GetDefaultComParameterValueAsByteField]] <br/> | ||
| + | [[Extensions.DiagCom.GetDefaultComParameterValueAsQuantity|GetDefaultComParameterValueAsQuantity]] | ||
Latest revision as of 02:17, 26 December 2019
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 comChannel, StringTerm comParameterName);Description
The GetDefaultComParameterValueAsString term will 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 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);
String1 = DiagCom.GetDefaultComParameterValueAsString(ComChannel1, "CP_ModifyTiming");See also
GetComChannel
GetComplexComParameter
SetComplexComParameter
GetDefaultComParameterValueAsBoolean
GetDefaultComParameterValueAsInteger
GetDefaultComParameterValueAsFloat
GetDefaultComParameterValueAsByteField
GetDefaultComParameterValueAsQuantity
