Interface MessageSignal.Builder

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

  • Method Details

    • topicName

      MessageSignal.Builder topicName(String topicName)

      The topic name for the message signal. It corresponds to topics in ROS 2.

      Parameters:
      topicName - The topic name for the message signal. It corresponds to topics in ROS 2.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • structuredMessage

      MessageSignal.Builder structuredMessage(StructuredMessage structuredMessage)

      The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.

      Parameters:
      structuredMessage - The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • structuredMessage

      default MessageSignal.Builder structuredMessage(Consumer<StructuredMessage.Builder> structuredMessage)

      The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.

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

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

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