Package com.viam.service.motion.v1

Interface Motion.MoveOnGlobeRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Motion.MoveOnGlobeRequest, Motion.MoveOnGlobeRequest.Builder
Enclosing class:
Motion
public static interface Motion.MoveOnGlobeRequestOrBuilder 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()
       Destination, encoded as a GeoPoint
      .viam.common.v1.GeoPoint destination = 2 [json_name = "destination"];
      Returns:
      Whether the destination field is set.

    • getDestination

      Common.GeoPoint getDestination()
       Destination, encoded as a GeoPoint
      .viam.common.v1.GeoPoint destination = 2 [json_name = "destination"];
      Returns:
      The destination.

    • hasHeading

      boolean hasHeading()
       Optional compass heading to achieve at the destination, in degrees [0-360)
      optional double heading = 3 [json_name = "heading"];
      Returns:
      Whether the heading field is set.

    • getHeading

      double getHeading()
       Optional compass heading to achieve at the destination, in degrees [0-360)
      optional double heading = 3 [json_name = "heading"];
      Returns:
      The heading.

    • hasComponentNameDeprecated

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

    • getComponentNameDeprecated

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

    • hasMovementSensorNameDeprecated

      @Deprecated boolean hasMovementSensorNameDeprecated()
      Deprecated.
      viam.service.motion.v1.MoveOnGlobeRequest.movement_sensor_name_deprecated is deprecated. See service/motion/v1/motion.proto;l=152
       Deprecated, use movement_sensor_name field.
      .viam.common.v1.ResourceName movement_sensor_name_deprecated = 5 [json_name = "movementSensorNameDeprecated", deprecated = true];
      Returns:
      Whether the movementSensorNameDeprecated field is set.

    • getMovementSensorNameDeprecated

      @Deprecated Common.ResourceName getMovementSensorNameDeprecated()
      Deprecated.
      viam.service.motion.v1.MoveOnGlobeRequest.movement_sensor_name_deprecated is deprecated. See service/motion/v1/motion.proto;l=152
       Deprecated, use movement_sensor_name field.
      .viam.common.v1.ResourceName movement_sensor_name_deprecated = 5 [json_name = "movementSensorNameDeprecated", deprecated = true];
      Returns:
      The movementSensorNameDeprecated.

    • getObstaclesList

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

    • getObstacles

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

    • getObstaclesCount

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

    • hasMotionConfiguration

      boolean hasMotionConfiguration()
       Optional set of motion configuration options
      optional .viam.service.motion.v1.MotionConfiguration motion_configuration = 7 [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 = 7 [json_name = "motionConfiguration"];
      Returns:
      The motionConfiguration.

    • getBoundingRegionsList

      List<Common.GeoGeometry> getBoundingRegionsList()
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • getBoundingRegions

      Common.GeoGeometry getBoundingRegions(int index)
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • getBoundingRegionsCount

      int getBoundingRegionsCount()
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • getComponentName

      String getComponentName()
       Component on the robot to move to the specified destination
      string component_name = 9 [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 = 9 [json_name = "componentName"];
      Returns:
      The bytes for componentName.

    • getMovementSensorName

      String getMovementSensorName()
       Name of the movement sensor which will be used to check robot location
      string movement_sensor_name = 10 [json_name = "movementSensorName"];
      Returns:
      The movementSensorName.

    • getMovementSensorNameBytes

      com.google.protobuf.ByteString getMovementSensorNameBytes()
       Name of the movement sensor which will be used to check robot location
      string movement_sensor_name = 10 [json_name = "movementSensorName"];
      Returns:
      The bytes for movementSensorName.

    • 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.