Extensions.DiagCom.GetComParameterValueAsQuantity
Jump to navigation
Jump to search
Contents
Classification
| Name | GetComParameterValueAsQuantity |
| Short Description | 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 |
Pseudo-Code Syntax
Quantity GetComParameterValueAsQuantity(ComChannel comChannel, String comParameterName);Description
The GetComParameterValueAsQuantity term return the current 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 current value of a Quantity communication parameter. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ComChannel | ComChannel | Term | - | [1] | Communication channel. |
| ComParameterName | String | Term | - | [1] | Name of communication channel. |
Examples
Quantity result = GetComParameterValueAsQuantity(comChannel, "parameterName");See also
GetComParameterValueAsBoolean
GetComParameterValueAsString
GetComParameterValueAsInteger
GetComParameterValueAsFloat
GetComParameterValueAsByteField
