Interface ResourceVelocityReceiver

All Superinterfaces:
OsidReceiver
public interface ResourceVelocityReceiver extends OsidReceiver

The resource route receiver is the consumer supplied interface for receiving notifications pertaining to changes of resource velocities.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedResourceVelocity(Id resourceId, Speed speed, Heading heading)
    The callback for notifications of resources changing speed or direction.
    void
    movingResource(Id resourceId)
    The callback for notifications of moving resources.
    void
    stoppedResource(Id resourceId)
    The callback for notifications of stopped resources.

    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

    • movingResource

      void movingResource(Id resourceId)
      The callback for notifications of moving resources.
      Parameters:
      resourceId - the Id of the Resource
      Compliance:
      mandatory - This method must be implemented.

    • stoppedResource

      void stoppedResource(Id resourceId)
      The callback for notifications of stopped resources.
      Parameters:
      resourceId - the Id of the Resource
      Compliance:
      mandatory - This method must be implemented.

    • changedResourceVelocity

      void changedResourceVelocity(Id resourceId, Speed speed, Heading heading)
      The callback for notifications of resources changing speed or direction.
      Parameters:
      resourceId - the Id of the Resource
      speed - the speed
      heading - the heading
      Compliance:
      mandatory - This method must be implemented.