ObdSignal (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iotfleetwise.model.ObdSignal

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ObdSignal()

Constructors
Constructor and Description
`ObdSignal()`

Method Summary

All Methods Instance Methods Concrete Methods
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()` Indicates where data appears in the message.
`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)` Indicates where data appears in the message.
`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)` Indicates where data appears in the message.
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ObdSignal
```
public ObdSignal()
```
- Method Detail
  - setPidResponseLength
```
public void setPidResponseLength(Integer pidResponseLength)
```
    The length of the requested data.
    
    Parameters:
    
    pidResponseLength - The length of the requested data.
  - getPidResponseLength
```
public Integer getPidResponseLength()
```
    The length of the requested data.
    
    Returns:
    
    The length of the requested data.
  - withPidResponseLength
```
public ObdSignal withPidResponseLength(Integer pidResponseLength)
```
    The length of the requested data.
    
    Parameters:
    
    pidResponseLength - The length of the requested data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceMode
```
public void setServiceMode(Integer serviceMode)
```
    The mode of operation (diagnostic service) in a message.
    
    Parameters:
    
    serviceMode - The mode of operation (diagnostic service) in a message.
  - getServiceMode
```
public Integer getServiceMode()
```
    The mode of operation (diagnostic service) in a message.
    
    Returns:
    
    The mode of operation (diagnostic service) in a message.
  - withServiceMode
```
public ObdSignal withServiceMode(Integer serviceMode)
```
    The mode of operation (diagnostic service) in a message.
    
    Parameters:
    
    serviceMode - The mode of operation (diagnostic service) in a message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPid
```
public void setPid(Integer pid)
```
    The diagnostic code used to request data from a vehicle for this signal.
    
    Parameters:
    
    pid - The diagnostic code used to request data from a vehicle for this signal.
  - getPid
```
public Integer getPid()
```
    The diagnostic code used to request data from a vehicle for this signal.
    
    Returns:
    
    The diagnostic code used to request data from a vehicle for this signal.
  - withPid
```
public ObdSignal withPid(Integer pid)
```
    The diagnostic code used to request data from a vehicle for this signal.
    
    Parameters:
    
    pid - The diagnostic code used to request data from a vehicle for this signal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScaling
```
public void setScaling(Double scaling)
```
    A multiplier used to decode the message.
    
    Parameters:
    
    scaling - A multiplier used to decode the message.
  - getScaling
```
public Double getScaling()
```
    A multiplier used to decode the message.
    
    Returns:
    
    A multiplier used to decode the message.
  - withScaling
```
public ObdSignal withScaling(Double scaling)
```
    A multiplier used to decode the message.
    
    Parameters:
    
    scaling - A multiplier used to decode the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOffset
```
public void setOffset(Double offset)
```
    Indicates where data appears in the message.
    
    Parameters:
    
    offset - Indicates where data appears in the message.
  - getOffset
```
public Double getOffset()
```
    Indicates where data appears in the message.
    
    Returns:
    
    Indicates where data appears in the message.
  - withOffset
```
public ObdSignal withOffset(Double offset)
```
    Indicates where data appears in the message.
    
    Parameters:
    
    offset - Indicates where data appears in the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartByte
```
public void setStartByte(Integer startByte)
```
    Indicates the beginning of the message.
    
    Parameters:
    
    startByte - Indicates the beginning of the message.
  - getStartByte
```
public Integer getStartByte()
```
    Indicates the beginning of the message.
    
    Returns:
    
    Indicates the beginning of the message.
  - withStartByte
```
public ObdSignal withStartByte(Integer startByte)
```
    Indicates the beginning of the message.
    
    Parameters:
    
    startByte - Indicates the beginning of the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setByteLength
```
public void setByteLength(Integer byteLength)
```
    The length of a message.
    
    Parameters:
    
    byteLength - The length of a message.
  - getByteLength
```
public Integer getByteLength()
```
    The length of a message.
    
    Returns:
    
    The length of a message.
  - withByteLength
```
public ObdSignal withByteLength(Integer byteLength)
```
    The length of a message.
    
    Parameters:
    
    byteLength - The length of a message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBitRightShift
```
public void setBitRightShift(Integer bitRightShift)
```
    The number of positions to shift bits in the message.
    
    Parameters:
    
    bitRightShift - The number of positions to shift bits in the message.
  - getBitRightShift
```
public Integer getBitRightShift()
```
    The number of positions to shift bits in the message.
    
    Returns:
    
    The number of positions to shift bits in the message.
  - withBitRightShift
```
public ObdSignal withBitRightShift(Integer bitRightShift)
```
    The number of positions to shift bits in the message.
    
    Parameters:
    
    bitRightShift - The number of positions to shift bits in the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBitMaskLength
```
public void setBitMaskLength(Integer bitMaskLength)
```
    The number of bits to mask in a message.
    
    Parameters:
    
    bitMaskLength - The number of bits to mask in a message.
  - getBitMaskLength
```
public Integer getBitMaskLength()
```
    The number of bits to mask in a message.
    
    Returns:
    
    The number of bits to mask in a message.
  - withBitMaskLength
```
public ObdSignal withBitMaskLength(Integer bitMaskLength)
```
    The number of bits to mask in a message.
    
    Parameters:
    
    bitMaskLength - The number of bits to mask in a message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ObdSignal clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ObdSignal

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ObdSignal

Method Detail

setPidResponseLength

getPidResponseLength

withPidResponseLength

setServiceMode

getServiceMode

withServiceMode

setPid

getPid

withPid

setScaling

getScaling

withScaling

setOffset

getOffset

withOffset

setStartByte

getStartByte

withStartByte

setByteLength

getByteLength

withByteLength

setBitRightShift

getBitRightShift

withBitRightShift

setBitMaskLength

getBitMaskLength

withBitMaskLength

toString

equals

hashCode

clone

marshall