org.opentcs.drivers.vehicle.management.VehicleCommAdapterPanelFactory Maven / Gradle / Ivy

Go to download
// SPDX-FileCopyrightText: The openTCS Authors
// SPDX-License-Identifier: MIT
package org.opentcs.drivers.vehicle.management;

import jakarta.annotation.Nonnull;
import java.util.List;
import org.opentcs.components.Lifecycle;
import org.opentcs.data.TCSObjectReference;
import org.opentcs.data.model.Vehicle;
import org.opentcs.drivers.vehicle.VehicleCommAdapterDescription;

/**
 * Provides comm adapter specific panels used for interaction and displaying information.
 */
public interface VehicleCommAdapterPanelFactory
    extends
      Lifecycle {

  /**
   * Returns a list of {@link VehicleCommAdapterPanel}s.
   *
   * @param description The description to create panels for.
   * @param vehicle The vehicle to create panels for.
   * @param processModel The current state of the process model a panel may want to initialize its
   * components with.
   * @return A list of comm adapter panels, or an empty list, if this factory cannot provide panels
   * for the given description.
   */
  List getPanelsFor(
      @Nonnull
      VehicleCommAdapterDescription description,
      @Nonnull
      TCSObjectReference vehicle,
      @Nonnull
      VehicleProcessModelTO processModel
  );
}