Interface ObdSignal.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ObdSignal.Builder,ObdSignal>, SdkBuilder<ObdSignal.Builder,ObdSignal>, SdkPojo
Enclosing class:
ObdSignal
@Mutable @NotThreadSafe public static interface ObdSignal.Builder extends SdkPojo, CopyableBuilder<ObdSignal.Builder,ObdSignal>

  • Method Details

    • pidResponseLength

      ObdSignal.Builder pidResponseLength(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.

    • serviceMode

      ObdSignal.Builder serviceMode(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.

    • pid

      ObdSignal.Builder pid(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.

    • scaling

      ObdSignal.Builder scaling(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.

    • offset

      ObdSignal.Builder offset(Double offset)

      The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.

      Parameters:
      offset - The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startByte

      ObdSignal.Builder startByte(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.

    • byteLength

      ObdSignal.Builder byteLength(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.

    • bitRightShift

      ObdSignal.Builder bitRightShift(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.

    • bitMaskLength

      ObdSignal.Builder bitMaskLength(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.

    • isSigned

      ObdSignal.Builder isSigned(Boolean isSigned)

      Determines whether the message is signed (true) or not (false). If it's signed, the message can represent both positive and negative numbers. The isSigned parameter only applies to the INTEGER raw signal type, and it doesn't affect the FLOATING_POINT raw signal type. The default value is false.

      Parameters:
      isSigned - Determines whether the message is signed (true) or not (false). If it's signed, the message can represent both positive and negative numbers. The isSigned parameter only applies to the INTEGER raw signal type, and it doesn't affect the FLOATING_POINT raw signal type. The default value is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • signalValueType

      ObdSignal.Builder signalValueType(String signalValueType)

      The value type of the signal. The default value is INTEGER.

      Parameters:
      signalValueType - The value type of the signal. The default value is INTEGER.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • signalValueType

      ObdSignal.Builder signalValueType(SignalValueType signalValueType)

      The value type of the signal. The default value is INTEGER.

      Parameters:
      signalValueType - The value type of the signal. The default value is INTEGER.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: