@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ObdSignal extends Object implements Serializable, Cloneable, StructuredPojo
Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
Constructor and Description |
---|
ObdSignal() |
Modifier and Type | Method and Description |
---|---|
ObdSignal |
clone() |
boolean |
equals(Object obj) |
Integer |
getBitMaskLength()
The number of bits to mask in a message.
|
Integer |
getBitRightShift()
The number of positions to shift bits in the message.
|
Integer |
getByteLength()
The length of a message.
|
Double |
getOffset()
The offset used to calculate the signal value.
|
Integer |
getPid()
The diagnostic code used to request data from a vehicle for this signal.
|
Integer |
getPidResponseLength()
The length of the requested data.
|
Double |
getScaling()
A multiplier used to decode the message.
|
Integer |
getServiceMode()
The mode of operation (diagnostic service) in a message.
|
Integer |
getStartByte()
Indicates the beginning of the message.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBitMaskLength(Integer bitMaskLength)
The number of bits to mask in a message.
|
void |
setBitRightShift(Integer bitRightShift)
The number of positions to shift bits in the message.
|
void |
setByteLength(Integer byteLength)
The length of a message.
|
void |
setOffset(Double offset)
The offset used to calculate the signal value.
|
void |
setPid(Integer pid)
The diagnostic code used to request data from a vehicle for this signal.
|
void |
setPidResponseLength(Integer pidResponseLength)
The length of the requested data.
|
void |
setScaling(Double scaling)
A multiplier used to decode the message.
|
void |
setServiceMode(Integer serviceMode)
The mode of operation (diagnostic service) in a message.
|
void |
setStartByte(Integer startByte)
Indicates the beginning of the message.
|
String |
toString()
Returns a string representation of this object.
|
ObdSignal |
withBitMaskLength(Integer bitMaskLength)
The number of bits to mask in a message.
|
ObdSignal |
withBitRightShift(Integer bitRightShift)
The number of positions to shift bits in the message.
|
ObdSignal |
withByteLength(Integer byteLength)
The length of a message.
|
ObdSignal |
withOffset(Double offset)
The offset used to calculate the signal value.
|
ObdSignal |
withPid(Integer pid)
The diagnostic code used to request data from a vehicle for this signal.
|
ObdSignal |
withPidResponseLength(Integer pidResponseLength)
The length of the requested data.
|
ObdSignal |
withScaling(Double scaling)
A multiplier used to decode the message.
|
ObdSignal |
withServiceMode(Integer serviceMode)
The mode of operation (diagnostic service) in a message.
|
ObdSignal |
withStartByte(Integer startByte)
Indicates the beginning of the message.
|
public void setPidResponseLength(Integer pidResponseLength)
The length of the requested data.
pidResponseLength
- The length of the requested data.public Integer getPidResponseLength()
The length of the requested data.
public ObdSignal withPidResponseLength(Integer pidResponseLength)
The length of the requested data.
pidResponseLength
- The length of the requested data.public void setServiceMode(Integer serviceMode)
The mode of operation (diagnostic service) in a message.
serviceMode
- The mode of operation (diagnostic service) in a message.public Integer getServiceMode()
The mode of operation (diagnostic service) in a message.
public ObdSignal withServiceMode(Integer serviceMode)
The mode of operation (diagnostic service) in a message.
serviceMode
- The mode of operation (diagnostic service) in a message.public void setPid(Integer pid)
The diagnostic code used to request data from a vehicle for this signal.
pid
- The diagnostic code used to request data from a vehicle for this signal.public Integer getPid()
The diagnostic code used to request data from a vehicle for this signal.
public ObdSignal withPid(Integer pid)
The diagnostic code used to request data from a vehicle for this signal.
pid
- The diagnostic code used to request data from a vehicle for this signal.public void setScaling(Double scaling)
A multiplier used to decode the message.
scaling
- A multiplier used to decode the message.public Double getScaling()
A multiplier used to decode the message.
public ObdSignal withScaling(Double scaling)
A multiplier used to decode the message.
scaling
- A multiplier used to decode the message.public void setOffset(Double offset)
The offset used to calculate the signal value. Combined with scaling, the calculation is
value = raw_value * scaling + offset
.
offset
- The offset used to calculate the signal value. Combined with scaling, the calculation is
value = raw_value * scaling + offset
.public Double getOffset()
The offset used to calculate the signal value. Combined with scaling, the calculation is
value = raw_value * scaling + offset
.
value = raw_value * scaling + offset
.public ObdSignal withOffset(Double offset)
The offset used to calculate the signal value. Combined with scaling, the calculation is
value = raw_value * scaling + offset
.
offset
- The offset used to calculate the signal value. Combined with scaling, the calculation is
value = raw_value * scaling + offset
.public void setStartByte(Integer startByte)
Indicates the beginning of the message.
startByte
- Indicates the beginning of the message.public Integer getStartByte()
Indicates the beginning of the message.
public ObdSignal withStartByte(Integer startByte)
Indicates the beginning of the message.
startByte
- Indicates the beginning of the message.public void setByteLength(Integer byteLength)
The length of a message.
byteLength
- The length of a message.public Integer getByteLength()
The length of a message.
public ObdSignal withByteLength(Integer byteLength)
The length of a message.
byteLength
- The length of a message.public void setBitRightShift(Integer bitRightShift)
The number of positions to shift bits in the message.
bitRightShift
- The number of positions to shift bits in the message.public Integer getBitRightShift()
The number of positions to shift bits in the message.
public ObdSignal withBitRightShift(Integer bitRightShift)
The number of positions to shift bits in the message.
bitRightShift
- The number of positions to shift bits in the message.public void setBitMaskLength(Integer bitMaskLength)
The number of bits to mask in a message.
bitMaskLength
- The number of bits to mask in a message.public Integer getBitMaskLength()
The number of bits to mask in a message.
public ObdSignal withBitMaskLength(Integer bitMaskLength)
The number of bits to mask in a message.
bitMaskLength
- The number of bits to mask in a message.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.