Enum Class CapacityAllocationPolicy

java.lang.Object

java.lang.Enum<CapacityAllocationPolicy>

neqsim.process.fielddevelopment.tieback.capacity.CapacityAllocationPolicy

All Implemented Interfaces:

Serializable, Comparable<CapacityAllocationPolicy>, Constable

public enum CapacityAllocationPolicy
extends Enum<CapacityAllocationPolicy>

Allocation policy used when host capacity is insufficient for base and satellite production.

Version:

1.0

Author:

ESOL

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASE_FIRST	Preserve existing host production first and allocate remaining capacity to the satellite.
PRO_RATA	Scale base and satellite production by the same feasible capacity factor.
SATELLITE_FIRST	Allocate host capacity to the satellite first, then hold back base production if required.
VALUE_WEIGHTED	Allocate capacity first to the stream with the highest period value.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CapacityAllocationPolicy()

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BASE_FIRST

public static final CapacityAllocationPolicy BASE_FIRST

Preserve existing host production first and allocate remaining capacity to the satellite.

SATELLITE_FIRST

public static final CapacityAllocationPolicy SATELLITE_FIRST

Allocate host capacity to the satellite first, then hold back base production if required.

PRO_RATA

public static final CapacityAllocationPolicy PRO_RATA

Scale base and satellite production by the same feasible capacity factor.

VALUE_WEIGHTED

public static final CapacityAllocationPolicy VALUE_WEIGHTED

Allocate capacity first to the stream with the highest period value.

Constructor Details

CapacityAllocationPolicy

private CapacityAllocationPolicy()

Method Details

values

public static CapacityAllocationPolicy[] 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 CapacityAllocationPolicy 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