burlap.behavior.singleagent.auxiliary.performance

Enum TrialMode

java.lang.Object

java.lang.Enum<TrialMode>

burlap.behavior.singleagent.auxiliary.performance.TrialMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TrialMode>

public enum TrialMode
extends java.lang.Enum<TrialMode>

Enumerator for specifying the what kinds of plots for each PerformanceMetric will be plotted by PerformancePlotter. The MOSTRECENTTTRIALONLY mode will result in only the most recent trial's performance being displayed. TRIALAVERAGESONLY will result in only plots for the trial averages to be shown. MOSTRECENTANDAVERAGE will result in both the most recent trial and the trial average plots to be shown.

Author:

James MacGlashan

Enum Constant Summary

Enum Constants

Enum Constant and Description
MOST_RECENT_AND_AVERAGE
MOST_RECENT_TRIAL_ONLY
TRIAL_AVERAGES_ONLY

Method Summary

Modifier and Type	Method and Description
boolean	averagesEnabled() Returns true if the trial average plots will be plotted by this mode.
boolean	mostRecentTrialEnabled() Returns true if the most recent trial plots will be plotted by this mode.
static TrialMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TrialMode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MOST_RECENT_TRIAL_ONLY

public static final TrialMode MOST_RECENT_TRIAL_ONLY

TRIAL_AVERAGES_ONLY

public static final TrialMode TRIAL_AVERAGES_ONLY

MOST_RECENT_AND_AVERAGE

public static final TrialMode MOST_RECENT_AND_AVERAGE

Method Detail

values

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

Returns:

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

valueOf

public static TrialMode 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

mostRecentTrialEnabled

public boolean mostRecentTrialEnabled()

Returns true if the most recent trial plots will be plotted by this mode.

Returns:

true if the most recent trial plots will be plotted by this mode; false otherwise.

averagesEnabled

public boolean averagesEnabled()

Returns true if the trial average plots will be plotted by this mode.

Returns:

true if the trial average plots will be plotted by this mode; false otherwise.