Interface ObstacleReceiver

All Superinterfaces:
OsidReceiver
public interface ObstacleReceiver extends OsidReceiver

The obstacle receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted obstacle.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedObstacles(IdList obstacleIds)
    The callback for notification of updated obstacles.
    void
    deletedObstacles(IdList obstacleIds)
    The callback for notification of deleted obstacles.
    void
    newObstacles(IdList obstacleIds)
    The callback for notifications of new obstacles.

    Methods inherited from interface OsidReceiver

    down, up
    Modifier and Type
    Method
    Description
    void
    down()
    The callback for notifications that the notification bus is not operating.
    void
    up()
    The callback for notifications that the notification bus is operational.

  • Method Details

    • newObstacles

      void newObstacles(IdList obstacleIds)
      The callback for notifications of new obstacles.
      Parameters:
      obstacleIds - the Ids of the new Obstacles
      Compliance:
      mandatory - This method must be implemented.

    • changedObstacles

      void changedObstacles(IdList obstacleIds)
      The callback for notification of updated obstacles.
      Parameters:
      obstacleIds - the Ids of the updated Obstacles
      Compliance:
      mandatory - This method must be implemented.

    • deletedObstacles

      void deletedObstacles(IdList obstacleIds)
      The callback for notification of deleted obstacles.
      Parameters:
      obstacleIds - the Ids of the deleted Obstacles
      Compliance:
      mandatory - This method must be implemented.