Package com.amalgamasimulation.discreterate

Enum Class Conveyor.DownstreamInflowRateShortagePolicy

java.lang.Object

java.lang.Enum<Conveyor.DownstreamInflowRateShortagePolicy>

com.amalgamasimulation.discreterate.Conveyor.DownstreamInflowRateShortagePolicy

All Implemented Interfaces:

Serializable, Comparable<Conveyor.DownstreamInflowRateShortagePolicy>, Constable

Enclosing class:

Conveyor<T>

public static enum Conveyor.DownstreamInflowRateShortagePolicy
extends Enum<Conveyor.DownstreamInflowRateShortagePolicy>

Defines the behavior of a Conveyor when the current rate of its currently exported ConveyorRateRecord exceeds the rate at which material can be imported by the downstream FlowElement.

Author:

Alexander Morozov

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHANGE_SPEED	If the rate of the current ConveyorRateRecord being exported exceeds the rate at which material can be imported by the downstream flow element, the speed of this Conveyor is reduced accordingly, which causes the current rate of the current ConveyorRateRecord to decrease.
STOP_CONVEYOR	If the rate of the current ConveyorRateRecord being exported exceeds the rate at which material can be imported by the downstream FlowElement, this Conveyor is stopped.

Method Summary

Modifier and Type	Method	Description
static Conveyor.DownstreamInflowRateShortagePolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Conveyor.DownstreamInflowRateShortagePolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STOP_CONVEYOR

public static final Conveyor.DownstreamInflowRateShortagePolicy STOP_CONVEYOR

If the rate of the current ConveyorRateRecord being exported exceeds the rate at which material can be imported by the downstream FlowElement, this Conveyor is stopped. The Conveyor starts moving again when the downstream flow element becomes available for receiving material at the rate of the ConveyorRateRecord being exported.

CHANGE_SPEED

public static final Conveyor.DownstreamInflowRateShortagePolicy CHANGE_SPEED

If the rate of the current ConveyorRateRecord being exported exceeds the rate at which material can be imported by the downstream flow element, the speed of this Conveyor is reduced accordingly, which causes the current rate of the current ConveyorRateRecord to decrease. At the same time, the max inflow rate of the Conveyor is reduced proportionally. After the current ConveyorRateRecord has been exported, the speed of the Conveyor and its initial max inflow rate are restored.

Method Details

values

public static Conveyor.DownstreamInflowRateShortagePolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Conveyor.DownstreamInflowRateShortagePolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null