Interface NavigationInterface

All Known Subinterfaces:
PR2BaseInterface
All Known Implementing Classes:
PR2BaseComponent

public interface NavigationInterface
Interface for complex/stateful motion commands (e.g., move to a location, turn a given amount).
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    cancelMotion(long aid)
    Cancel current Motion.
    checkMotion(long aid)
    Check status of current Motion.
    long
    moveDist(double dist)
    Move forward a specified distance.
    long
    moveTo(double xdest, double ydest)
    Move to a global location.
  • Method Details

    • moveTo

      long moveTo(double xdest, double ydest)
      Move to a global location.
      Parameters:
      xdest - the x-coordinate of the destination
      ydest - the y-coordinate of the destination
      Returns:
      an identifying timestamp for the move action
    • moveDist

      long moveDist(double dist)
      Move forward a specified distance.
      Parameters:
      dist - the distance (in meters) to move
      Returns:
      an identifying timestamp for the move action
    • checkMotion

      ActionStatus checkMotion(long aid)
      Check status of current Motion. Soon this will be obsoleted, as the motion commands will notify Action of their completions.
      Parameters:
      aid - the identifying timestamp of the action to check
      Returns:
      the status found for the indicated action
    • cancelMotion

      boolean cancelMotion(long aid)
      Cancel current Motion.
      Parameters:
      aid - the identifying timestamp of the action to cancel
      Returns:
      true if action was canceled, false otherwise (i.e., if that action ID was not active)