Difference between revisions of "Extensions.DiagCom.GetDefaultComParameterValueAsQuantity"
Jump to navigation
Jump to search
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:DiagCom]] | + | {{DISPLAYTITLE:OTX '''GetDefaultComParameterValueAsQuantity'''}}[[Category:DiagCom]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetDefaultComParameterValueAsQuantity | | + | {{ClassificationActivity | GetDefaultComParameterValueAsQuantity | Gets the default 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 == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | QuantityTerm | + | QuantityTerm DiagCom.GetDefaultComParameterValueAsQuantity(ComChannelTerm comChannel, StringTerm comParameterName); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetDefaultComParameterValueAsQuantity''' term return the default value of a [[Quantity]] communication parameter. | + | The '''GetDefaultComParameterValueAsQuantity''' term will return the default value of a [[Extensions.Quantities.Quantity|quantity]] communication parameter. |
| − | {{TermReturnValue| [[Quantity]] | The default value of a [[Quantity]] communication parameter.}} | + | {{TermReturnValue| [[Extensions.Quantities.Quantity|Quantity]] | The default value of a [[Extensions.Quantities.Quantity|quantity]] 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.}} |
|} | |} | ||
== 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; | ||
Quantities.Quantity Quantity1; | Quantities.Quantity Quantity1; | ||
| − | + | /// Flow | |
| − | + | ||
| − | Quantity1 = DiagCom.GetDefaultComParameterValueAsQuantity( | + | ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false); |
| + | Quantity1 = DiagCom.GetDefaultComParameterValueAsQuantity(ComChannel1, "CP_TesterPresentTime"); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[GetDefaultComParameterValueAsBoolean]] <br/> | + | [[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> |
| − | [[GetDefaultComParameterValueAsString]] <br/> | + | [[Extensions.DiagCom.GetComplexComParameter|GetComplexComParameter]] <br/> |
| − | [[GetDefaultComParameterValueAsInteger]] <br/> | + | [[Extensions.DiagCom.SetComplexComParameter|SetComplexComParameter]] <br/> |
| − | [[GetDefaultComParameterValueAsFloat]] <br/> | + | [[Extensions.DiagCom.GetDefaultComParameterValueAsBoolean|GetDefaultComParameterValueAsBoolean]] <br/> |
| − | [[GetDefaultComParameterValueAsByteField]] | + | [[Extensions.DiagCom.GetDefaultComParameterValueAsString|GetDefaultComParameterValueAsString]] <br/> |
| + | [[Extensions.DiagCom.GetDefaultComParameterValueAsInteger|GetDefaultComParameterValueAsInteger]] <br/> | ||
| + | [[Extensions.DiagCom.GetDefaultComParameterValueAsFloat|GetDefaultComParameterValueAsFloat]] <br/> | ||
| + | [[Extensions.DiagCom.GetDefaultComParameterValueAsByteField|GetDefaultComParameterValueAsByteField]] | ||
Latest revision as of 04:14, 26 December 2019
Contents
Classification
| Name | GetDefaultComParameterValueAsQuantity |
| Short Description | Gets the default 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.GetDefaultComParameterValueAsQuantity(ComChannelTerm comChannel, StringTerm comParameterName);Description
The GetDefaultComParameterValueAsQuantity term will return the default value of a quantity 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 |
| Quantity | The default value of a quantity 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;
Quantities.Quantity Quantity1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
Quantity1 = DiagCom.GetDefaultComParameterValueAsQuantity(ComChannel1, "CP_TesterPresentTime");See also
GetComChannel
GetComplexComParameter
SetComplexComParameter
GetDefaultComParameterValueAsBoolean
GetDefaultComParameterValueAsString
GetDefaultComParameterValueAsInteger
GetDefaultComParameterValueAsFloat
GetDefaultComParameterValueAsByteField
