org.opentcs.kernel.services.StandardDispatcherService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opentcs-kernel Show documentation
opentcs-kernel
There is a newer version: 6.1.2
// SPDX-FileCopyrightText: The openTCS Authors
// SPDX-License-Identifier: MIT
package org.opentcs.kernel.services;

import static java.util.Objects.requireNonNull;

import jakarta.inject.Inject;
import org.opentcs.components.kernel.Dispatcher;
import org.opentcs.components.kernel.dipatching.TransportOrderAssignmentException;
import org.opentcs.components.kernel.services.DispatcherService;
import org.opentcs.customizations.kernel.GlobalSyncObject;
import org.opentcs.data.ObjectUnknownException;
import org.opentcs.data.TCSObjectReference;
import org.opentcs.data.model.Vehicle;
import org.opentcs.data.order.ReroutingType;
import org.opentcs.data.order.TransportOrder;
import org.opentcs.kernel.workingset.TCSObjectRepository;

/**
 * This class is the standard implementation of the {@link DispatcherService} interface.
 */
public class StandardDispatcherService
    implements
      DispatcherService {

  /**
   * A global object to be used for synchronization within the kernel.
   */
  private final Object globalSyncObject;
  /**
   * The container of all course model and transport order objects.
   */
  private final TCSObjectRepository objectRepo;
  /**
   * The dispatcher.
   */
  private final Dispatcher dispatcher;

  /**
   * Creates a new instance.
   *
   * @param globalSyncObject The kernel threads' global synchronization object.
   * @param objectRepo The object repo to be used.
   * @param dispatcher The dispatcher.
   */
  @Inject
  public StandardDispatcherService(
      @GlobalSyncObject
      Object globalSyncObject,
      TCSObjectRepository objectRepo,
      Dispatcher dispatcher
  ) {
    this.globalSyncObject = requireNonNull(globalSyncObject, "globalSyncObject");
    this.objectRepo = requireNonNull(objectRepo, "objectRepo");
    this.dispatcher = requireNonNull(dispatcher, "dispatcher");
  }

  @Override
  public void dispatch() {
    synchronized (globalSyncObject) {
      dispatcher.dispatch();
    }
  }

  @Override
  public void withdrawByVehicle(TCSObjectReference ref, boolean immediateAbort)
      throws ObjectUnknownException {
    requireNonNull(ref, "ref");

    synchronized (globalSyncObject) {
      dispatcher.withdrawOrder(objectRepo.getObject(Vehicle.class, ref), immediateAbort);
    }
  }

  @Override
  public void withdrawByTransportOrder(
      TCSObjectReference ref,
      boolean immediateAbort
  )
      throws ObjectUnknownException {
    requireNonNull(ref, "ref");

    synchronized (globalSyncObject) {
      dispatcher.withdrawOrder(
          objectRepo.getObject(TransportOrder.class, ref),
          immediateAbort
      );
    }
  }

  @Override
  public void reroute(TCSObjectReference ref, ReroutingType reroutingType)
      throws ObjectUnknownException {
    requireNonNull(ref, "ref");
    requireNonNull(reroutingType, "reroutingType");

    synchronized (globalSyncObject) {
      dispatcher.reroute(objectRepo.getObject(Vehicle.class, ref), reroutingType);
    }
  }

  @Override
  public void rerouteAll(ReroutingType reroutingType) {
    synchronized (globalSyncObject) {
      dispatcher.rerouteAll(reroutingType);
    }
  }

  @Override
  public void assignNow(TCSObjectReference ref)
      throws ObjectUnknownException,
        TransportOrderAssignmentException {
    requireNonNull(ref, "ref");

    synchronized (globalSyncObject) {
      dispatcher.assignNow(objectRepo.getObject(TransportOrder.class, ref));
    }
  }
}