/AWS1/CL_IOIOBDSIGNAL¶
Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_pidresponselength TYPE /AWS1/IOIPOSITIVEINTEGER /AWS1/IOIPOSITIVEINTEGER¶
The length of the requested data.
iv_servicemode TYPE /AWS1/IOINONNEGATIVEINTEGER /AWS1/IOINONNEGATIVEINTEGER¶
The mode of operation (diagnostic service) in a message.
iv_pid TYPE /AWS1/IOINONNEGATIVEINTEGER /AWS1/IOINONNEGATIVEINTEGER¶
The diagnostic code used to request data from a vehicle for this signal.
iv_scaling TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING¶
A multiplier used to decode the message.
iv_offset TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING¶
The offset used to calculate the signal value. Combined with scaling, the calculation is
value = raw_value * scaling + offset.
iv_startbyte TYPE /AWS1/IOINONNEGATIVEINTEGER /AWS1/IOINONNEGATIVEINTEGER¶
Indicates the beginning of the message.
iv_bytelength TYPE /AWS1/IOIOBDBYTELENGTH /AWS1/IOIOBDBYTELENGTH¶
The length of a message.
Optional arguments:¶
iv_bitrightshift TYPE /AWS1/IOINONNEGATIVEINTEGER /AWS1/IOINONNEGATIVEINTEGER¶
The number of positions to shift bits in the message.
iv_bitmasklength TYPE /AWS1/IOIOBDBITMASKLENGTH /AWS1/IOIOBDBITMASKLENGTH¶
The number of bits to mask in a message.
iv_issigned TYPE /AWS1/IOIPRIMITIVEBOOLEAN /AWS1/IOIPRIMITIVEBOOLEAN¶
Determines whether the message is signed (
true) or not (false). If it's signed, the message can represent both positive and negative numbers. TheisSignedparameter only applies to theINTEGERraw signal type, and it doesn't affect theFLOATING_POINTraw signal type. The default value isfalse.
iv_signalvaluetype TYPE /AWS1/IOISIGNALVALUETYPE /AWS1/IOISIGNALVALUETYPE¶
The value type of the signal. The default value is
INTEGER.
Queryable Attributes¶
pidResponseLength¶
The length of the requested data.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PIDRESPONSELENGTH() |
Getter for PIDRESPONSELENGTH, with configurable default |
ASK_PIDRESPONSELENGTH() |
Getter for PIDRESPONSELENGTH w/ exceptions if field has no v |
HAS_PIDRESPONSELENGTH() |
Determine if PIDRESPONSELENGTH has a value |
serviceMode¶
The mode of operation (diagnostic service) in a message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEMODE() |
Getter for SERVICEMODE |
pid¶
The diagnostic code used to request data from a vehicle for this signal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PID() |
Getter for PID |
scaling¶
A multiplier used to decode the message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCALING() |
Getter for SCALING, with configurable default |
ASK_SCALING() |
Getter for SCALING w/ exceptions if field has no value |
STR_SCALING() |
String format for SCALING, with configurable default |
HAS_SCALING() |
Determine if SCALING has a value |
offset¶
The offset used to calculate the signal value. Combined with scaling, the calculation is
value = raw_value * scaling + offset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OFFSET() |
Getter for OFFSET, with configurable default |
ASK_OFFSET() |
Getter for OFFSET w/ exceptions if field has no value |
STR_OFFSET() |
String format for OFFSET, with configurable default |
HAS_OFFSET() |
Determine if OFFSET has a value |
startByte¶
Indicates the beginning of the message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTBYTE() |
Getter for STARTBYTE |
byteLength¶
The length of a message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BYTELENGTH() |
Getter for BYTELENGTH, with configurable default |
ASK_BYTELENGTH() |
Getter for BYTELENGTH w/ exceptions if field has no value |
HAS_BYTELENGTH() |
Determine if BYTELENGTH has a value |
bitRightShift¶
The number of positions to shift bits in the message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BITRIGHTSHIFT() |
Getter for BITRIGHTSHIFT |
bitMaskLength¶
The number of bits to mask in a message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BITMASKLENGTH() |
Getter for BITMASKLENGTH, with configurable default |
ASK_BITMASKLENGTH() |
Getter for BITMASKLENGTH w/ exceptions if field has no value |
HAS_BITMASKLENGTH() |
Determine if BITMASKLENGTH has a value |
isSigned¶
Determines whether the message is signed (
true) or not (false). If it's signed, the message can represent both positive and negative numbers. TheisSignedparameter only applies to theINTEGERraw signal type, and it doesn't affect theFLOATING_POINTraw signal type. The default value isfalse.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISSIGNED() |
Getter for ISSIGNED, with configurable default |
ASK_ISSIGNED() |
Getter for ISSIGNED w/ exceptions if field has no value |
HAS_ISSIGNED() |
Determine if ISSIGNED has a value |
signalValueType¶
The value type of the signal. The default value is
INTEGER.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SIGNALVALUETYPE() |
Getter for SIGNALVALUETYPE, with configurable default |
ASK_SIGNALVALUETYPE() |
Getter for SIGNALVALUETYPE w/ exceptions if field has no val |
HAS_SIGNALVALUETYPE() |
Determine if SIGNALVALUETYPE has a value |