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.

    • hasComponentName

      boolean hasComponentName()
       Component on the robot to move to the specified destination
      .viam.common.v1.ResourceName component_name = 4 [json_name = "componentName"];
      Returns:
      Whether the componentName field is set.

    • getComponentName

      Common.ResourceName getComponentName()
       Component on the robot to move to the specified destination
      .viam.common.v1.ResourceName component_name = 4 [json_name = "componentName"];
      Returns:
      The componentName.

    • hasMovementSensorName

      boolean hasMovementSensorName()
       Name of the movement sensor which will be used to check robot location
      .viam.common.v1.ResourceName movement_sensor_name = 5 [json_name = "movementSensorName"];
      Returns:
      Whether the movementSensorName field is set.

    • getMovementSensorName

      Common.ResourceName getMovementSensorName()
       Name of the movement sensor which will be used to check robot location
      .viam.common.v1.ResourceName movement_sensor_name = 5 [json_name = "movementSensorName"];
      Returns:
      The movementSensorName.

    • 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"];

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