Package repast.simphony.engine.environment

Interface ControllerAction

All Known Subinterfaces:

DescriptorControllerAction<T>

All Known Implementing Classes:

AbstractControllerAction, BuilderDataLoaderControllerAction, ChartServerControllerAction, ClassNameDataLoaderAction, ConsoleSinkComponentControllerAction, ContextXMLDataLoaderAction, DataLoaderControllerAction, DataSetComponentControllerAction, DefaultContextSchedulableControllerAction, DefaultControllerAction, DefaultRandomStreamAction, DefaultSchedulableAction, DefaultUserPanelDescriptorAction, DFDataLoaderControllerAction, DFFreezerControllerAction, DisplayComponentControllerAction, DisplayServerControllerAction, FileSinkComponentControllerAction, FreezerControllerAction, GeographyProjectionController, GeographyVizProjectionController, HistogramComponentControllerAction, JDBCDataLoaderControllerAction, JDBCFreezerControllerAction, MIContextXMLDataLoaderAction, NullAbstractControllerAction, ScheduledMethodControllerAction, SchedulingControllerAction, TimeSeriesComponentControllerAction, WatcherControllerAction, XMLDataLoaderAction

public interface ControllerAction

An action performed by the Controller. This action performs initialization and cleanup activities for the setup/tear-down of a simulation.

The batch methods are called once for every set of runs in a batch run. Run methods are called once for every run. For example, a batch run could have 50 runs occur in it, one for each set of parameters in a parameter sweep. The batch methods would be called once, while the run methods would be called 50 times.

Version:

$Revision: 1.1 $ $Date: 2005/12/21 22:25:34 $

Author:

Jerry Vos

Method Summary

Modifier and Type	Method	Description
void	batchCleanup(RunState runState, Object contextId)	Cleans up the action after a batch run (a set of runs).
void	batchInitialize(RunState runState, Object contextId)	Initializes the action for a batch run (a set of runs).
void	runCleanup(RunState runState, Object contextId)	Cleans up the action after a run just occurred.
void	runInitialize(RunState runState, Object contextId, Parameters runParams)	Initializes the action for a single run (possibly one of many).

Method Detail

batchInitialize

void batchInitialize(RunState runState,
                     Object contextId)

Initializes the action for a batch run (a set of runs).

Parameters:

runState -

runInitialize

void runInitialize(RunState runState,
                   Object contextId,
                   Parameters runParams)

Initializes the action for a single run (possibly one of many).

Parameters:

runState -

runParams - the current run's parameters

runCleanup

void runCleanup(RunState runState,
                Object contextId)

Cleans up the action after a run just occurred.

Parameters:

runState - information on the run that just occurred

batchCleanup

void batchCleanup(RunState runState,
                  Object contextId)

Cleans up the action after a batch run (a set of runs).

Parameters:

runState - information on the set of runs that just occurred