Package com.viam.service.motion.v1

Interface Motion.MoveOnMapRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Motion.MoveOnMapRequest, Motion.MoveOnMapRequest.Builder
Enclosing class:
Motion
public static interface Motion.MoveOnMapRequestOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Details

    • getName

      String getName()
       Name of the motion service
      string name = 1 [json_name = "name"];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Name of the motion service
      string name = 1 [json_name = "name"];
      Returns:
      The bytes for name.

    • hasDestination

      boolean hasDestination()
       Specify a destination to, which can be any pose with respect to the SLAM map's origin
      .viam.common.v1.Pose destination = 2 [json_name = "destination"];
      Returns:
      Whether the destination field is set.

    • getDestination

      Common.Pose getDestination()
       Specify a destination to, which can be any pose with respect to the SLAM map's origin
      .viam.common.v1.Pose destination = 2 [json_name = "destination"];
      Returns:
      The destination.

    • hasComponentNameDeprecated

      @Deprecated boolean hasComponentNameDeprecated()
      Deprecated.
      viam.service.motion.v1.MoveOnMapRequest.component_name_deprecated is deprecated. See service/motion/v1/motion.proto;l=97
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 3 [json_name = "componentNameDeprecated", deprecated = true];
      Returns:
      Whether the componentNameDeprecated field is set.

    • getComponentNameDeprecated

      @Deprecated Common.ResourceName getComponentNameDeprecated()
      Deprecated.
      viam.service.motion.v1.MoveOnMapRequest.component_name_deprecated is deprecated. See service/motion/v1/motion.proto;l=97
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 3 [json_name = "componentNameDeprecated", deprecated = true];
      Returns:
      The componentNameDeprecated.

    • hasSlamServiceNameDeprecated

      @Deprecated boolean hasSlamServiceNameDeprecated()
      Deprecated.
      viam.service.motion.v1.MoveOnMapRequest.slam_service_name_deprecated is deprecated. See service/motion/v1/motion.proto;l=99
       Deprecated, use slam_service_name field.
      .viam.common.v1.ResourceName slam_service_name_deprecated = 4 [json_name = "slamServiceNameDeprecated", deprecated = true];
      Returns:
      Whether the slamServiceNameDeprecated field is set.

    • getSlamServiceNameDeprecated

      @Deprecated Common.ResourceName getSlamServiceNameDeprecated()
      Deprecated.
      viam.service.motion.v1.MoveOnMapRequest.slam_service_name_deprecated is deprecated. See service/motion/v1/motion.proto;l=99
       Deprecated, use slam_service_name field.
      .viam.common.v1.ResourceName slam_service_name_deprecated = 4 [json_name = "slamServiceNameDeprecated", deprecated = true];
      Returns:
      The slamServiceNameDeprecated.

    • hasMotionConfiguration

      boolean hasMotionConfiguration()
       Optional set of motion configuration options
      optional .viam.service.motion.v1.MotionConfiguration motion_configuration = 5 [json_name = "motionConfiguration"];
      Returns:
      Whether the motionConfiguration field is set.

    • getMotionConfiguration

      Motion.MotionConfiguration getMotionConfiguration()
       Optional set of motion configuration options
      optional .viam.service.motion.v1.MotionConfiguration motion_configuration = 5 [json_name = "motionConfiguration"];
      Returns:
      The motionConfiguration.

    • getObstaclesList

      List<Common.Geometry> getObstaclesList()
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.Geometry obstacles = 6 [json_name = "obstacles"];

    • getObstacles

      Common.Geometry getObstacles(int index)
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.Geometry obstacles = 6 [json_name = "obstacles"];

    • getObstaclesCount

      int getObstaclesCount()
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.Geometry obstacles = 6 [json_name = "obstacles"];

    • getComponentName

      String getComponentName()
       Component on the robot to move to the specified destination
      string component_name = 7 [json_name = "componentName"];
      Returns:
      The componentName.

    • getComponentNameBytes

      com.google.protobuf.ByteString getComponentNameBytes()
       Component on the robot to move to the specified destination
      string component_name = 7 [json_name = "componentName"];
      Returns:
      The bytes for componentName.

    • getSlamServiceName

      String getSlamServiceName()
       Name of the slam service from which the SLAM map is requested
      string slam_service_name = 8 [json_name = "slamServiceName"];
      Returns:
      The slamServiceName.

    • getSlamServiceNameBytes

      com.google.protobuf.ByteString getSlamServiceNameBytes()
       Name of the slam service from which the SLAM map is requested
      string slam_service_name = 8 [json_name = "slamServiceName"];
      Returns:
      The bytes for slamServiceName.

    • hasExtra

      boolean hasExtra()
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Returns:
      Whether the extra field is set.

    • getExtra

      com.google.protobuf.Struct getExtra()
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Returns:
      The extra.