Extensions.ComInterface.GetIgnitionStateFromComInterface
Jump to navigation
Jump to search
Classification
| Name | GetIgnitionStateFromComInterface |
| Short Description | Return type of the returned value is BooleanTerm, where value true means clamp on, false means clamp off. |
| Class | Term |
| Extension | OTX ComInterface extension |
| Group | ComInterface related Terms |
| Exceptions | IgnitionStateException NotConnectedException |
| Checker Rules | |
| Standard Compliant | Yes |
OTL Syntax
BooleanTerm ComInterface.GetIgnitionStateFromComInterface(ComInterfaceTerm comInterface);
Description
This term is a BooleanTerm. It will return the current state of the ignition clamp.
Return type of the returned value is BooleanTerm, where value true means clamp on, false means clamp off.
The appropriate MVCI system operation is MCDInterface::getClampState().
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 state of the ignition clamp. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| comInterface | ComInterface | Term | - | [1..1] | This element identifies the communication interface. |
