Package org.opentcs.components.kernel.services

Schnittstelle PeripheralDispatcherService

public interface PeripheralDispatcherService
Provides methods concerning the PeripheralJobDispatcher.

  • Methodendetails

    • dispatch

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

      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.

    • withdrawByLocation

      void withdrawByLocation(TCSResourceReference<Location> ref) throws ObjectUnknownException, KernelRuntimeException
      Withdraw any job that a peripheral device (represented by the given location) 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 location representing the peripheral device.
      Löst aus:
      ObjectUnknownException - If the referenced location does not exist.
      KernelRuntimeException - In case there is an exception executing this method.

    • withdrawByPeripheralJob

      void withdrawByPeripheralJob(TCSObjectReference<PeripheralJob> ref) throws ObjectUnknownException, KernelRuntimeException
      Withdraw the given peripheral job.

      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 peripheral job to be withdrawn.
      Löst aus:
      ObjectUnknownException - If the referenced peripheral job does not exist.
      KernelRuntimeException - In case there is an exception executing this method.