org.opentcs.drivers.peripherals.management.PeripheralCommAdapterPanelFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentcs-api-base Show documentation

opentcs-api-base

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.drivers.peripherals.management;

import jakarta.annotation.Nonnull;
import java.util.List;
import org.opentcs.components.Lifecycle;
import org.opentcs.data.model.Location;
import org.opentcs.data.model.TCSResourceReference;
import org.opentcs.drivers.peripherals.PeripheralCommAdapterDescription;
import org.opentcs.drivers.peripherals.PeripheralProcessModel;

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

  /**
   * Returns a list of {@link PeripheralCommAdapterPanel}s.
   *
   * @param description The description to create panels for.
   * @param location The location 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
      PeripheralCommAdapterDescription description,
      @Nonnull
      TCSResourceReference location,
      @Nonnull
      PeripheralProcessModel processModel
  );
}