org.simbrain.util.environment

Enum SmellSource.DecayFunction

java.lang.Object

java.lang.Enum<SmellSource.DecayFunction>

org.simbrain.util.environment.SmellSource.DecayFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SmellSource.DecayFunction>

Enclosing class:

SmellSource

public static enum SmellSource.DecayFunction
extends java.lang.Enum<SmellSource.DecayFunction>

Decay Functions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GAUSSIAN
LINEAR
QUADRATIC
STEP

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()
static SmellSource.DecayFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SmellSource.DecayFunction[]	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

STEP

public static final SmellSource.DecayFunction STEP

LINEAR

public static final SmellSource.DecayFunction LINEAR

GAUSSIAN

public static final SmellSource.DecayFunction GAUSSIAN

QUADRATIC

public static final SmellSource.DecayFunction QUADRATIC

Method Detail

values

public static SmellSource.DecayFunction[] 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 (SmellSource.DecayFunction c : SmellSource.DecayFunction.values())
    System.out.println(c);

Returns:

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

valueOf

public static SmellSource.DecayFunction valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<SmellSource.DecayFunction>