Package repast.simphony.parameter.optimizer

Enum Class AdvanceType

java.lang.Object

java.lang.Enum<AdvanceType>

repast.simphony.parameter.optimizer.AdvanceType

All Implemented Interfaces:

Serializable, Comparable<AdvanceType>, java.lang.constant.Constable

public enum AdvanceType
extends Enum<AdvanceType>

This represents the directions/actions the sweeper can take. These correlate to the methods in OptimizableParameterSetter. An AdvancementChooser will specify one of these types and the parameter sweeper will attempt to follow that instruction if it can.

Author:

Jerry Vos

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
BACKWARD	Move backward in the space (ie left or up)
FORWARD	Move forward in the space (ie right or down)
RANDOM	Move to a random position in the space
SWITCH	Switch to a different parameter

Method Summary

Modifier and Type	Method	Description
static AdvanceType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AdvanceType[]	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

FORWARD

public static final AdvanceType FORWARD

Move forward in the space (ie right or down)

BACKWARD

public static final AdvanceType BACKWARD

Move backward in the space (ie left or up)

RANDOM

public static final AdvanceType RANDOM

Move to a random position in the space

SWITCH

public static final AdvanceType SWITCH

Switch to a different parameter

Method Details

values

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