Difference between revisions of "Extensions.DiagCom.GetDefaultComParameterValueAsInteger"
Jump to navigation
Jump to search
| (4 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | IntegerVariable DiagCom.GetDefaultComParameterValueAsInteger(ComChannelTerm comChannel, StringTerm comParameterName); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetDefaultComParameterValueAsInteger''' term | + | The '''GetDefaultComParameterValueAsInteger''' term will 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] | The '''ComChannelTerm''' specifies the '''ComChannel''' which | + | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | The '''ComChannelTerm''' specifies the '''ComChannel''' which will be queried.}} |
{{TableRowPropertie2| ComParameterName | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The '''otx:StringTerm''' specifies the name of a communication parameter.}} | {{TableRowPropertie2| ComParameterName | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The '''otx:StringTerm''' specifies the name of a communication parameter.}} | ||
|} | |} | ||
| Line 22: | Line 22: | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
Integer Integer1; | Integer Integer1; | ||
Latest revision as of 04:13, 26 December 2019
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
IntegerVariable DiagCom.GetDefaultComParameterValueAsInteger(ComChannelTerm comChannel, StringTerm comParameterName);Description
The GetDefaultComParameterValueAsInteger term will 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 will be queried. |
| ComParameterName | String | Term | - | [1] | The otx:StringTerm specifies the name of a communication parameter. |
OTL Examples
/// Local Declarations
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
