Difference between revisions of "Extensions.DiagCom.GetDefaultComParameterValueAsInteger"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''GetDefaultComParameterValueAsInteger'''}}[[Category:DiagCom]] | {{DISPLAYTITLE:OTX '''GetDefaultComParameterValueAsInteger'''}}[[Category:DiagCom]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetDefaultComParameterValueAsInteger | | + | {{ClassificationActivity | GetDefaultComParameterValueAsInteger | Gets the default value of a [[Core.DataTypes.SimpleDataType.Integer|Integer]] 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 '''GetDefaultComParameterValueAsInteger''' term return the default value of | + | The '''GetDefaultComParameterValueAsInteger''' term comprises the '''ChannelAndParameterName''' attribute group and shall return the default value of an [[Core.DataTypes.SimpleDataType.Integer|integer]] type communication parameter. |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The default value of a [[Core.DataTypes.SimpleDataType.Integer|Integer]] communication parameter.}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The default value of a [[Core.DataTypes.SimpleDataType.Integer|Integer]] 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; |
| − | |||
Integer Integer1; | Integer Integer1; | ||
| − | + | /// Flow | |
| − | + | ||
| − | Integer1 = DiagCom.GetDefaultComParameterValueAsInteger( | + | ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false); |
| + | Integer1 = DiagCom.GetDefaultComParameterValueAsInteger(ComChannel1, "CP_TesterPresentTime"); | ||
</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.GetDefaultComParameterValueAsString|GetDefaultComParameterValueAsString]] <br/> | [[Extensions.DiagCom.GetDefaultComParameterValueAsString|GetDefaultComParameterValueAsString]] <br/> | ||
Revision as of 10:21, 15 October 2018
Contents
Classification
| Name | GetDefaultComParameterValueAsInteger |
| Short Description | Gets the default value of a Integer communication parameter |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | ComParam related terms |
| Exceptions | UnknownTargetException TypeMismatchException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
IntegerTerm = DiagCom.GetDefaultComParameterValueAsInteger(ComChannelTerm, StringTerm);Description
The GetDefaultComParameterValueAsInteger term comprises the ChannelAndParameterName attribute group and shall return the default value of an integer 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 |
| Integer | The default value of a Integer 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;
Integer Integer1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
Integer1 = DiagCom.GetDefaultComParameterValueAsInteger(ComChannel1, "CP_TesterPresentTime");See also
GetComChannel
GetComplexComParameter
SetComplexComParameter
GetDefaultComParameterValueAsBoolean
GetDefaultComParameterValueAsString
GetDefaultComParameterValueAsFloat
GetDefaultComParameterValueAsByteField
GetDefaultComParameterValueAsQuantity
