Package org.opentcs.components.kernel.services

Schnittstelle DispatcherService

public interface DispatcherService
Provides methods concerning the Dispatcher.

  • Methodendetails

    • dispatch

      void dispatch() throws KernelRuntimeException
      Explicitly trigger the dispatching process.

      If called within the kernel application, this method is supposed to be called only on the kernel executor thread.

      Löst aus:
      KernelRuntimeException - In case there is an exception executing this method.

    • withdrawByVehicle

      void withdrawByVehicle(TCSObjectReference<Vehicle> ref, boolean immediateAbort) throws ObjectUnknownException, KernelRuntimeException
      Withdraw any order that a vehicle might be processing.

      If called within the kernel application, this method is supposed to be called only on the kernel executor thread.

      Parameter:
      ref - A reference to the vehicle to be modified.
      immediateAbort - If false, this method once will initiate the withdrawal, leaving the transport order assigned to the vehicle until it has finished the movements that it has already been ordered to execute. The transport order's state will change to TransportOrder.State.WITHDRAWN. If true, the dispatcher will withdraw the order from the vehicle without further waiting.
      Löst aus:
      ObjectUnknownException - If the referenced vehicle does not exist.
      KernelRuntimeException - In case there is an exception executing this method.

    • withdrawByTransportOrder

      void withdrawByTransportOrder(TCSObjectReference<TransportOrder> ref, boolean immediateAbort) throws ObjectUnknownException, KernelRuntimeException
      Withdraw the referenced order.

      If called within the kernel application, this method is supposed to be called only on the kernel executor thread.

      Parameter:
      ref - A reference to the transport order to be withdrawn.
      immediateAbort - If false, this method once will initiate the withdrawal, leaving the transport order assigned to the vehicle until it has finished the movements that it has already been ordered to execute. The transport order's state will change to TransportOrder.State.WITHDRAWN. If true, the dispatcher will withdraw the order from the vehicle without further waiting.
      Löst aus:
      ObjectUnknownException - If the referenced transport order does not exist.
      KernelRuntimeException - In case there is an exception executing this method.

    • reroute

      void reroute(@Nonnull TCSObjectReference<Vehicle> ref, @Nonnull ReroutingType reroutingType) throws ObjectUnknownException, KernelRuntimeException
      Explicitly trigger a rerouting for the given vehicles.

      If called within the kernel application, this method is supposed to be called only on the kernel executor thread.

      Parameter:
      ref - The vehicle to be rerouted.
      reroutingType - The type of the requested rerouting.
      Löst aus:
      ObjectUnknownException
      KernelRuntimeException

    • rerouteAll

      void rerouteAll(@Nonnull ReroutingType reroutingType)
      Explicitly trigger a rerouting for all vehicles.

      If called within the kernel application, this method is supposed to be called only on the kernel executor thread.

      Parameter:
      reroutingType - The type of rerouting.

    • assignNow

      void assignNow(TCSObjectReference<TransportOrder> ref) throws ObjectUnknownException, TransportOrderAssignmentException, KernelRuntimeException
      Assign the referenced transport order (to its intended vehicle) now.

      If called within the kernel application, this method is supposed to be called only on the kernel executor thread.

      Parameter:
      ref - The transport order to be assigned.
      Löst aus:
      ObjectUnknownException - If the referenced transport order does not exist.
      TransportOrderAssignmentException - If the given transport order could not be assigned to its intended vehicle.
      KernelRuntimeException - In case there is an exception executing this method.