Package com.viam.service.navigation.v1

Interface Navigation.PathOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Navigation.Path, Navigation.Path.Builder
Enclosing class:
Navigation
public static interface Navigation.PathOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDestinationWaypointId()
    The id of the user specified waypoint
    com.google.protobuf.ByteString
    getDestinationWaypointIdBytes()
    The id of the user specified waypoint
    Common.GeoPoint
    getGeopoints(int index)
    List of geopoints that the motion planner output to reach the destination The first geopoint is the starting position of the robot for that path
    int
    getGeopointsCount()
    List of geopoints that the motion planner output to reach the destination The first geopoint is the starting position of the robot for that path
    List<Common.GeoPoint>
    getGeopointsList()
    List of geopoints that the motion planner output to reach the destination The first geopoint is the starting position of the robot for that path

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getDestinationWaypointId

      String getDestinationWaypointId()
       The id of the user specified waypoint
      string destination_waypoint_id = 1 [json_name = "destinationWaypointId"];
      Returns:
      The destinationWaypointId.

    • getDestinationWaypointIdBytes

      com.google.protobuf.ByteString getDestinationWaypointIdBytes()
       The id of the user specified waypoint
      string destination_waypoint_id = 1 [json_name = "destinationWaypointId"];
      Returns:
      The bytes for destinationWaypointId.

    • getGeopointsList

      List<Common.GeoPoint> getGeopointsList()
       List of geopoints that the motion planner output to reach the destination
 The first geopoint is the starting position of the robot for that path
      repeated .viam.common.v1.GeoPoint geopoints = 2 [json_name = "geopoints"];

    • getGeopoints

      Common.GeoPoint getGeopoints(int index)
       List of geopoints that the motion planner output to reach the destination
 The first geopoint is the starting position of the robot for that path
      repeated .viam.common.v1.GeoPoint geopoints = 2 [json_name = "geopoints"];

    • getGeopointsCount

      int getGeopointsCount()
       List of geopoints that the motion planner output to reach the destination
 The first geopoint is the starting position of the robot for that path
      repeated .viam.common.v1.GeoPoint geopoints = 2 [json_name = "geopoints"];