org.opentcs.strategies.basic.peripherals.dispatching.DefaultPeripheralReleaseStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentcs-strategies-default Show documentation

openTCS-Strategies-Default

There is a newer version: 6.2.0

Show newest version

/**
 * 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.strategies.basic.peripherals.dispatching;

import java.util.Collection;
import java.util.stream.Collectors;
import org.opentcs.data.model.Location;
import org.opentcs.data.model.PeripheralInformation;

/**
 * The default implementation of {@link PeripheralReleaseStrategy}.
 * Selects peripherals to be released by applying the following rules:
 * 
 * A peripheral's state must be {@link PeripheralInformation.State#IDLE}
 * A peripheral's processing state must be {@link PeripheralInformation.ProcState#IDLE}
 * A peripheral's reservation token must be set.
 * 
 */
public class DefaultPeripheralReleaseStrategy
    implements
      PeripheralReleaseStrategy {

  /**
   * Creates a new instance.
   */
  public DefaultPeripheralReleaseStrategy() {
  }

  @Override
  public Collection selectPeripheralsToRelease(Collection locations) {
    return locations.stream()
        .filter(this::idleAndReserved)
        .collect(Collectors.toSet());
  }

  private boolean idleAndReserved(Location location) {
    return processesNoJob(location) && hasReservationToken(location);
  }

  private boolean processesNoJob(Location location) {
    return location.getPeripheralInformation()
        .getProcState() == PeripheralInformation.ProcState.IDLE
        && location.getPeripheralInformation().getState() == PeripheralInformation.State.IDLE;
  }

  private boolean hasReservationToken(Location location) {
    return location.getPeripheralInformation().getReservationToken() != null;
  }
}