Interface SignalDecoder.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SignalDecoder.Builder,SignalDecoder>, SdkBuilder<SignalDecoder.Builder,SignalDecoder>, SdkPojo
Enclosing class:
SignalDecoder
public static interface SignalDecoder.Builder extends SdkPojo, CopyableBuilder<SignalDecoder.Builder,SignalDecoder>

  • Method Details

    • fullyQualifiedName

      SignalDecoder.Builder fullyQualifiedName(String fullyQualifiedName)

      The fully qualified name of a signal decoder as defined in a vehicle model.

      Parameters:
      fullyQualifiedName - The fully qualified name of a signal decoder as defined in a vehicle model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      SignalDecoder.Builder type(String type)

      The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

      Parameters:
      type - The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      SignalDecoder.Builder type(SignalDecoderType type)

      The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

      Parameters:
      type - The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • interfaceId

      SignalDecoder.Builder interfaceId(String interfaceId)

      The ID of a network interface that specifies what network protocol a vehicle follows.

      Parameters:
      interfaceId - The ID of a network interface that specifies what network protocol a vehicle follows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • canSignal

      SignalDecoder.Builder canSignal(CanSignal canSignal)

      Information about signal decoder using the Controller Area Network (CAN) protocol.

      Parameters:
      canSignal - Information about signal decoder using the Controller Area Network (CAN) protocol.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • canSignal

      default SignalDecoder.Builder canSignal(Consumer<CanSignal.Builder> canSignal)

      Information about signal decoder using the Controller Area Network (CAN) protocol.

      This is a convenience method that creates an instance of the CanSignal.Builder avoiding the need to create one manually via CanSignal.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to canSignal(CanSignal).

      Parameters:
      canSignal - a consumer that will call methods on CanSignal.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • obdSignal

      SignalDecoder.Builder obdSignal(ObdSignal obdSignal)

      Information about signal decoder using the On-board diagnostic (OBD) II protocol.

      Parameters:
      obdSignal - Information about signal decoder using the On-board diagnostic (OBD) II protocol.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • obdSignal

      default SignalDecoder.Builder obdSignal(Consumer<ObdSignal.Builder> obdSignal)

      Information about signal decoder using the On-board diagnostic (OBD) II protocol.

      This is a convenience method that creates an instance of the ObdSignal.Builder avoiding the need to create one manually via ObdSignal.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to obdSignal(ObdSignal).

      Parameters:
      obdSignal - a consumer that will call methods on ObdSignal.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • messageSignal

      SignalDecoder.Builder messageSignal(MessageSignal messageSignal)

      The decoding information for a specific message which supports higher order data types.

      Parameters:
      messageSignal - The decoding information for a specific message which supports higher order data types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messageSignal

      default SignalDecoder.Builder messageSignal(Consumer<MessageSignal.Builder> messageSignal)

      The decoding information for a specific message which supports higher order data types.

      This is a convenience method that creates an instance of the MessageSignal.Builder avoiding the need to create one manually via MessageSignal.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to messageSignal(MessageSignal).

      Parameters:
      messageSignal - a consumer that will call methods on MessageSignal.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: