Difference between revisions of "Extensions.DiagCom.GetComParameterValueAsInteger"
Jump to navigation
Jump to search
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''GetComParameterValueAsInteger'''}}[[Category:DiagCom]] | {{DISPLAYTITLE:OTX '''GetComParameterValueAsInteger'''}}[[Category:DiagCom]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetComParameterValueAsInteger | | + | {{ClassificationActivity | GetComParameterValueAsInteger | Gets the current 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 == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | IntegerTerm | + | IntegerTerm DiagCom.GetComParameterValueAsInteger(ComChannelTerm comChannel, StringTerm comParameterName); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetComParameterValueAsInteger''' term return the current value of | + | The '''GetComParameterValueAsInteger''' term will return the current value of an [[Core.DataTypes.SimpleDataType.Integer|integer]] type communication parameter. If the communication parameter has not been previously modified by the [[Extensions.DiagCom.SetComParameter|SetComParameter]] action, the default parameter value will be returned. |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The current value of a [[Core.DataTypes.SimpleDataType.Integer|Integer]] communication parameter.}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The current 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 will 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 | + | /// Local Declarations |
| − | + | ||
| + | DiagCom.ComChannel ComChannel1; | ||
Integer Integer1; | Integer Integer1; | ||
| − | + | /// Flow | |
| − | + | ||
| − | Integer1 = DiagCom.GetComParameterValueAsInteger( | + | ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false); |
| + | [#MetaData(RequestPdu), <#Data>22 01 00</#Data>] | ||
| + | DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, NULL, NULL, false, false); | ||
| + | Integer1 = DiagCom.GetComParameterValueAsInteger(ComChannel1, "CP_RC21CompletionTimeout"); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| + | [[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> | ||
| + | [[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/> | ||
| + | [[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/> | ||
| + | [[Extensions.DiagCom.GetComplexComParameter|GetComplexComParameter]] <br/> | ||
| + | [[Extensions.DiagCom.SetComplexComParameter|SetComplexComParameter]] <br/> | ||
[[Extensions.DiagCom.GetComParameterValueAsBoolean|GetComParameterValueAsBoolean]] <br/> | [[Extensions.DiagCom.GetComParameterValueAsBoolean|GetComParameterValueAsBoolean]] <br/> | ||
[[Extensions.DiagCom.GetComParameterValueAsString|GetComParameterValueAsString]] <br/> | [[Extensions.DiagCom.GetComParameterValueAsString|GetComParameterValueAsString]] <br/> | ||
Latest revision as of 09:51, 24 December 2019
Contents
Classification
| Name | GetComParameterValueAsInteger |
| Short Description | Gets the current 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.GetComParameterValueAsInteger(ComChannelTerm comChannel, StringTerm comParameterName);Description
The GetComParameterValueAsInteger term will return the current value of an integer type communication parameter. If the communication parameter has not been previously modified by the SetComParameter action, the default parameter value will be returned.
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 current 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);
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, NULL, NULL, false, false);
Integer1 = DiagCom.GetComParameterValueAsInteger(ComChannel1, "CP_RC21CompletionTimeout");See also
GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetComplexComParameter
SetComplexComParameter
GetComParameterValueAsBoolean
GetComParameterValueAsString
GetComParameterValueAsFloat
GetComParameterValueAsByteField
GetComParameterValueAsQuantity
