Extensions.DiagCom.GetComParameterValueAsBoolean
Jump to navigation
Jump to search
Contents
Classification
| Name | GetComParameterValueAsBoolean |
| Short Description | The current value of a Boolean communication parameter |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | ComParam related terms |
| Exceptions | UnknownTargetException TypeMismatchException |
| Checker Rules | - |
| Standard Compliant | Yes |
Pseudo-Code Syntax
Boolean GetComParameterValueAsBoolean(ComChannel comChannel, String comParameterName);
Description
The GetComParameterValueAsBoolean term return the current value of a Boolean 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 |
| Boolean | The current value of a Boolean 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
Boolean result = GetComParameterValueAsBoolean(comChannel, "parameterName");
See also
GetComParameterValueAsString
GetComParameterValueAsInteger
GetComParameterValueAsFloat
GetComParameterValueAsByteField
GetComParameterValueAsQuantity
