Difference between revisions of "Extensions.DiagCom.GetDefaultComParameterValueAsQuantity"
Jump to navigation
Jump to search
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | The '''GetDefaultComParameterValueAsQuantity''' term comprises the '''ChannelAndParameterName''' attribute group and | + | The '''GetDefaultComParameterValueAsQuantity''' term comprises the '''ChannelAndParameterName''' attribute group and will return the default value of a [[Extensions.Quantities.Quantity|quantity]] communication parameter. |
{{TermReturnValue| [[Extensions.Quantities.Quantity|Quantity]] | The default value of a [[Extensions.Quantities.Quantity|quantity]] communication parameter.}} | {{TermReturnValue| [[Extensions.Quantities.Quantity|Quantity]] | The default 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] | 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.}} | ||
|} | |} | ||
Revision as of 10:26, 12 September 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 comprises the ChannelAndParameterName attribute group and 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
