Overview | Package | Class | Tree | Deprecated | Index | Help
| ContactCenters V. 0.9.9.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

## umontreal.iro.lecuyer.contactcenters.app
Enum EvalOptionType

    java.lang.Object
      java.lang.Enum<EvalOptionType>
          umontreal.iro.lecuyer.contactcenters.app.EvalOptionType

All Implemented Interfaces:
  Serializable, Comparable<EvalOptionType>

    public enum EvalOptionType

extends Enum<EvalOptionType>

Represents an evaluation option type for a contact center evaluation system. An evaluation option is an external parameter that can be changed from evaluations to evaluations. In particular, it can be a decision variable or a simulation stopping condition. An object of this class must be passed as a key to `ContactCenterEval.setEvalOption(umontreal.iro.lecuyer.contactcenters.app.EvalOptionType, java.lang.Object)` to select which evaluation option to modify.

Enum Constant Summary
`CURRENTPERIOD` This integer can be used to set the current period for a multi-period model evaluated in a single period, as if this period length was infinite.
`QUEUECAPACITY` Corresponds to an integer giving the maximal capacity of the waiting queue.
`SCHEDULEDAGENTS` Corresponds to a 2D array of integers giving the number of agents in each shift for each agent group.
`SIMSTOPPINGCONDITION` Can be used to define an additionnal stopping condition for a simulation.
`STAFFINGMATRIX` Corresponds to a 2D array of integers giving the number of agents in each group and main period.
`STAFFINGVECTOR` Corresponds to an array of integers giving the number of agents in each group and main period.

Method Summary
`String` | `getName()` Returns the name of this evaluation option.
`Class<?>` | `getType()` Returns the class of the objects representing values for this option.
`String` | `toString()`
`static EvalOptionType` | `valueOf(String name)` Returns the enum constant of this type with the specified name.
`static EvalOptionType[]` | `values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

### STAFFINGVECTOR

    public static final EvalOptionType STAFFINGVECTOR

  Corresponds to an array of integers giving the number of agents in each group and main period. For a single-period or stationary simulation, the length of the array corresponds to I and element i gives the number of agents in group i. For a multi-periods simulation, the length must be IP, and for a period p and the agent group i, the number of agents is given by the element with index Pi + p. For example, in a simulation with two agent groups and two main periods, the vector {1, 2, 3, 4} would set the number of agents in group 0 to 1 for the first main period and 2 for the second one.

### STAFFINGMATRIX

    public static final EvalOptionType STAFFINGMATRIX

  Corresponds to a 2D array of integers giving the number of agents in each group and main period. Element (i, p) of this array gives the number of agents in group i during main period p. If a single period is simulated as if it was infinite in the model, the matrix has a single column. Otherwise, it has P columns.

### SCHEDULEDAGENTS

    public static final EvalOptionType SCHEDULEDAGENTS

  Corresponds to a 2D array of integers giving the number of agents in each shift for each agent group. Element (i, j) of the 2D array gives the number of agents in shift j for agent group i. If agent group i does not use a schedule, the corresponding array in the 2D array is `null`.

### QUEUECAPACITY

    public static final EvalOptionType QUEUECAPACITY

  Corresponds to an integer giving the maximal capacity of the waiting queue. An infinite capacity is represented by the value `Integer.MAX_VALUE`.

### SIMSTOPPINGCONDITION

    public static final EvalOptionType SIMSTOPPINGCONDITION

  Can be used to define an additionnal stopping condition for a simulation. By default, a simulator stops the simulation when some conditions apply, e.g., a fixed simulation length or a target relative error on some predetermined performance measures. This option can be used to add a user-defined stopping condition which will be checked in addition to the default conditions. The value of this option can be `null` (the default) or a reference to a `SimStoppingCondition` object.

### CURRENTPERIOD

    public static final EvalOptionType CURRENTPERIOD

  This integer can be used to set the current period for a multi-period model evaluated in a single period, as if this period length was infinite.

Method Detail

### values

    public static EvalOptionType[] values()

  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

      for (EvalOptionType c : EvalOptionType.values())
          System.out.println(c);

  Returns:
    an array containing the constants of this enum type, in the order they are declared

### valueOf

    public static EvalOptionType valueOf(String name)

  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
    `NullPointerException` - if the argument is null

### getName

    public String getName()

  Returns the name of this evaluation option.

  Returns:
    the name of the option.

### getType

    public Class<?> getType()

  Returns the class of the objects representing values for this option.

  Returns:
    the type of the option.

### toString

    public String toString()

  Overrides:
    `toString` in class `Enum<EvalOptionType>`

Overview | Package | Class | Tree | Deprecated | Index | Help
| ContactCenters V. 0.9.9.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

To submit a bug or ask questions, send an e-mail to Richard Simard.