Extensions.DiagCom.GetParameterValueAsBoolean
Jump to navigation
Jump to search
Contents
Classification
| Name | GetParameterValueAsBoolean |
| Short Description | The actual value of the parameter as a Boolean |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | Parameter related terms |
| Exceptions | TypeMismatchException |
| Checker Rules | - |
| Standard Compliant | Yes |
Pseudo-Code Syntax
Boolean GetParameterValueAsBoolean(Parameter parameter);Description
The GetParameterValueAsBoolean term accepts a ParameterTerm and returns the actual value of the parameter as a Boolean quantity.
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 actual value of the parameter as a Boolean.) |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Parameter | Parameter | Term | - | [1] | The parameter object. |
Examples
Boolean value = GetParameterValueAsBoolean(parameter);See also
GetParameterValueAsString
GetParameterValueAsInteger
GetParameterValueAsFloat
GetParameterValueAsByteField
GetParameterValueAsQuantity
