Difference between revisions of "Extensions.DiagCom.GetComParameterValueAsQuantity"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''GetComParameterValueAsQuantity '''}}[[Category:DiagCom]] | {{DISPLAYTITLE:OTX '''GetComParameterValueAsQuantity '''}}[[Category:DiagCom]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetComParameterValueAsQuantity | | + | {{ClassificationActivity | GetComParameterValueAsQuantity | Gets the current value of a [[Extensions.Quantities.Quantity|Quantity]] 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 '''GetComParameterValueAsQuantity''' term return the current value of a [[Extensions.Quantities.Quantity| | + | The '''GetComParameterValueAsQuantity''' term comprises the '''ChannelAndParameterName''' attribute group and shall return the current value of a [[Extensions.Quantities.Quantity|quantity]] type communication parameter. If the communication parameter has not been previously modified by the [[Extensions.DiagCom.SetComParameter|SetComParameter]] action, the default parameter value shall be returned. |
{{TermReturnValue| [[Extensions.Quantities.Quantity|Quantity]] | The current value of a [[Extensions.Quantities.Quantity|Quantity]] communication parameter.}} | {{TermReturnValue| [[Extensions.Quantities.Quantity|Quantity]] | The current value of a [[Extensions.Quantities.Quantity|Quantity]] 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; |
| − | + | Quantity Quantity1; | |
| − | |||
| − | + | /// Flow | |
| − | + | ||
| − | Quantity1 = DiagCom.GetComParameterValueAsQuantity( | + | 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); | ||
| + | Quantity1 = DiagCom.GetComParameterValueAsQuantity(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/> | ||
Revision as of 09:44, 15 October 2018
Contents
Classification
| Name | GetComParameterValueAsQuantity |
| Short Description | Gets the current value of a Quantity communication parameter |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | ComParam related terms |
| Exceptions | UnknownTargetException TypeMismatchException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
QuantityTerm = DiagCom.GetComParameterValueAsQuantity(ComChannelTerm, StringTerm);Description
The GetComParameterValueAsQuantity term comprises the ChannelAndParameterName attribute group and shall return the current value of a quantity type communication parameter. If the communication parameter has not been previously modified by the SetComParameter action, the default parameter value shall 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 |
| Quantity | The current value of a Quantity 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;
Quantity Quantity1;
/// 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);
Quantity1 = DiagCom.GetComParameterValueAsQuantity(ComChannel1, "CP_RC21CompletionTimeout");See also
GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetComplexComParameter
SetComplexComParameter
GetComParameterValueAsBoolean
GetComParameterValueAsString
GetComParameterValueAsInteger
GetComParameterValueAsFloat
GetComParameterValueAsByteField
