org.opentcs.kernel.vehicles.LocalVehicleControllerPool 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.2.0

/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.kernel.vehicles;

import org.opentcs.components.Lifecycle;
import org.opentcs.drivers.vehicle.VehicleCommAdapter;
import org.opentcs.drivers.vehicle.VehicleControllerPool;

/**
 * Manages the attachment of vehicle controllers to vehicles and comm adapters.
 */
public interface LocalVehicleControllerPool
    extends
      VehicleControllerPool,
      Lifecycle {

  /**
   * Associates a vehicle controller with a named vehicle and a comm adapter.
   *
   * @param vehicleName The name of the vehicle.
   * @param commAdapter The communication adapter that is going to control the physical vehicle.
   */
  void attachVehicleController(String vehicleName, VehicleCommAdapter commAdapter)
      throws IllegalArgumentException;

  /**
   * Disassociates a vehicle control and a comm adapter from a vehicle.
   *
   * @param vehicleName The name of the vehicle from which to detach.
   */
  void detachVehicleController(String vehicleName);
}