Package com.viam.service.navigation.v1

Class Navigation.Status.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<Navigation.Status,Navigation.Status.Builder>
com.google.protobuf.GeneratedMessageLite.Builder<Navigation.Status,Navigation.Status.Builder>
com.viam.service.navigation.v1.Navigation.Status.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Navigation.StatusOrBuilder, Cloneable
Enclosing class:
Navigation.Status
public static final class Navigation.Status.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<Navigation.Status,Navigation.Status.Builder> implements Navigation.StatusOrBuilder
 Status is the robot navigation state returned by GetNavigationStatus and by methods that
 start, suspend, or resume motion. The robot is idle when goal is unset or
 goal.state is terminal. It is moving when goal.state == GOAL_STATE_ACTIVE.
 Methods that start motion fail while localized is false.
Protobuf type viam.service.navigation.v1.Status

  • Method Details

    • hasPosition

      public boolean hasPosition()
       Same as GetPosition
      .viam.service.navigation.v1.Position position = 1 [json_name = "position"];
      Specified by:
      hasPosition in interface Navigation.StatusOrBuilder
      Returns:
      Whether the position field is set.

    • getPosition

      public Navigation.Position getPosition()
       Same as GetPosition
      .viam.service.navigation.v1.Position position = 1 [json_name = "position"];
      Specified by:
      getPosition in interface Navigation.StatusOrBuilder
      Returns:
      The position.

    • setPosition

      public Navigation.Status.Builder setPosition(Navigation.Position value)
       Same as GetPosition
      .viam.service.navigation.v1.Position position = 1 [json_name = "position"];

    • setPosition

      public Navigation.Status.Builder setPosition(Navigation.Position.Builder builderForValue)
       Same as GetPosition
      .viam.service.navigation.v1.Position position = 1 [json_name = "position"];

    • mergePosition

      public Navigation.Status.Builder mergePosition(Navigation.Position value)
       Same as GetPosition
      .viam.service.navigation.v1.Position position = 1 [json_name = "position"];

    • clearPosition

      public Navigation.Status.Builder clearPosition()
       Same as GetPosition
      .viam.service.navigation.v1.Position position = 1 [json_name = "position"];

    • getLocalized

      public boolean getLocalized()
       Pose is trusted; false blocks new goals
      bool localized = 2 [json_name = "localized"];
      Specified by:
      getLocalized in interface Navigation.StatusOrBuilder
      Returns:
      The localized.

    • setLocalized

      public Navigation.Status.Builder setLocalized(boolean value)
       Pose is trusted; false blocks new goals
      bool localized = 2 [json_name = "localized"];
      Parameters:
      value - The localized to set.
      Returns:
      This builder for chaining.

    • clearLocalized

      public Navigation.Status.Builder clearLocalized()
       Pose is trusted; false blocks new goals
      bool localized = 2 [json_name = "localized"];
      Returns:
      This builder for chaining.

    • hasVelocity

      public boolean hasVelocity()
       Current body-frame velocity; zero when stopped
      .viam.service.navigation.v1.Velocity velocity = 3 [json_name = "velocity"];
      Specified by:
      hasVelocity in interface Navigation.StatusOrBuilder
      Returns:
      Whether the velocity field is set.

    • getVelocity

      public Navigation.Velocity getVelocity()
       Current body-frame velocity; zero when stopped
      .viam.service.navigation.v1.Velocity velocity = 3 [json_name = "velocity"];
      Specified by:
      getVelocity in interface Navigation.StatusOrBuilder
      Returns:
      The velocity.

    • setVelocity

      public Navigation.Status.Builder setVelocity(Navigation.Velocity value)
       Current body-frame velocity; zero when stopped
      .viam.service.navigation.v1.Velocity velocity = 3 [json_name = "velocity"];

    • setVelocity

      public Navigation.Status.Builder setVelocity(Navigation.Velocity.Builder builderForValue)
       Current body-frame velocity; zero when stopped
      .viam.service.navigation.v1.Velocity velocity = 3 [json_name = "velocity"];

    • mergeVelocity

      public Navigation.Status.Builder mergeVelocity(Navigation.Velocity value)
       Current body-frame velocity; zero when stopped
      .viam.service.navigation.v1.Velocity velocity = 3 [json_name = "velocity"];

    • clearVelocity

      public Navigation.Status.Builder clearVelocity()
       Current body-frame velocity; zero when stopped
      .viam.service.navigation.v1.Velocity velocity = 3 [json_name = "velocity"];

    • hasGoal

      public boolean hasGoal()
       Latest goal; unset until the first one
      optional .viam.service.navigation.v1.GoalStatus goal = 4 [json_name = "goal"];
      Specified by:
      hasGoal in interface Navigation.StatusOrBuilder
      Returns:
      Whether the goal field is set.

    • getGoal

      public Navigation.GoalStatus getGoal()
       Latest goal; unset until the first one
      optional .viam.service.navigation.v1.GoalStatus goal = 4 [json_name = "goal"];
      Specified by:
      getGoal in interface Navigation.StatusOrBuilder
      Returns:
      The goal.

    • setGoal

      public Navigation.Status.Builder setGoal(Navigation.GoalStatus value)
       Latest goal; unset until the first one
      optional .viam.service.navigation.v1.GoalStatus goal = 4 [json_name = "goal"];

    • setGoal

      public Navigation.Status.Builder setGoal(Navigation.GoalStatus.Builder builderForValue)
       Latest goal; unset until the first one
      optional .viam.service.navigation.v1.GoalStatus goal = 4 [json_name = "goal"];

    • mergeGoal

      public Navigation.Status.Builder mergeGoal(Navigation.GoalStatus value)
       Latest goal; unset until the first one
      optional .viam.service.navigation.v1.GoalStatus goal = 4 [json_name = "goal"];

    • clearGoal

      public Navigation.Status.Builder clearGoal()
       Latest goal; unset until the first one
      optional .viam.service.navigation.v1.GoalStatus goal = 4 [json_name = "goal"];

    • hasUpdatedAt

      public boolean hasUpdatedAt()
      .google.protobuf.Timestamp updated_at = 5 [json_name = "updatedAt"];
      Specified by:
      hasUpdatedAt in interface Navigation.StatusOrBuilder
      Returns:
      Whether the updatedAt field is set.

    • getUpdatedAt

      public com.google.protobuf.Timestamp getUpdatedAt()
      .google.protobuf.Timestamp updated_at = 5 [json_name = "updatedAt"];
      Specified by:
      getUpdatedAt in interface Navigation.StatusOrBuilder
      Returns:
      The updatedAt.

    • setUpdatedAt

      public Navigation.Status.Builder setUpdatedAt(com.google.protobuf.Timestamp value)
      .google.protobuf.Timestamp updated_at = 5 [json_name = "updatedAt"];

    • setUpdatedAt

      public Navigation.Status.Builder setUpdatedAt(com.google.protobuf.Timestamp.Builder builderForValue)
      .google.protobuf.Timestamp updated_at = 5 [json_name = "updatedAt"];

    • mergeUpdatedAt

      public Navigation.Status.Builder mergeUpdatedAt(com.google.protobuf.Timestamp value)
      .google.protobuf.Timestamp updated_at = 5 [json_name = "updatedAt"];

    • clearUpdatedAt

      public Navigation.Status.Builder clearUpdatedAt()
      .google.protobuf.Timestamp updated_at = 5 [json_name = "updatedAt"];

    • hasExtra

      public boolean hasExtra()
       Backend-specific diagnostics
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Specified by:
      hasExtra in interface Navigation.StatusOrBuilder
      Returns:
      Whether the extra field is set.

    • getExtra

      public com.google.protobuf.Struct getExtra()
       Backend-specific diagnostics
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Specified by:
      getExtra in interface Navigation.StatusOrBuilder
      Returns:
      The extra.

    • setExtra

      public Navigation.Status.Builder setExtra(com.google.protobuf.Struct value)
       Backend-specific diagnostics
      .google.protobuf.Struct extra = 99 [json_name = "extra"];

    • setExtra

      public Navigation.Status.Builder setExtra(com.google.protobuf.Struct.Builder builderForValue)
       Backend-specific diagnostics
      .google.protobuf.Struct extra = 99 [json_name = "extra"];

    • mergeExtra

      public Navigation.Status.Builder mergeExtra(com.google.protobuf.Struct value)
       Backend-specific diagnostics
      .google.protobuf.Struct extra = 99 [json_name = "extra"];

    • clearExtra

      public Navigation.Status.Builder clearExtra()
       Backend-specific diagnostics
      .google.protobuf.Struct extra = 99 [json_name = "extra"];