org.opentcs.kernel.OrderPoolConfiguration 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;

import org.opentcs.configuration.ConfigurationEntry;
import org.opentcs.configuration.ConfigurationPrefix;
import org.opentcs.kernel.workingset.WorkingSetCleanupTask;

/**
 * Provides methods to configure the {@link WorkingSetCleanupTask}.
 */
@ConfigurationPrefix(OrderPoolConfiguration.PREFIX)
public interface OrderPoolConfiguration {

  /**
   * This configuration's prefix.
   */
  String PREFIX = "orderpool";

  @ConfigurationEntry(
      type = "Long",
      description = "The interval between sweeps (in ms).",
      changesApplied = ConfigurationEntry.ChangesApplied.ON_NEW_PLANT_MODEL
  )
  long sweepInterval();

  @ConfigurationEntry(
      type = "Integer",
      description = "The minimum age of orders or peripheral jobs to remove in a sweep (in ms).",
      changesApplied = ConfigurationEntry.ChangesApplied.INSTANTLY
  )
  int sweepAge();
}