Package repast.simphony.engine.environment

Class AbstractRunner

java.lang.Object

repast.simphony.engine.environment.AbstractRunner

All Implemented Interfaces:

Runner, Executor<RunState>

Direct Known Subclasses:

BatchScheduleRunner, DefaultScheduleRunner, GUIScheduleRunner, InteractivBatchRunner

public abstract class AbstractRunner
extends Object
implements Runner

Author:

Nick Collier

Field Summary

Fields

Modifier and Type	Field	Description
protected Controller	controller
protected RunEnvironmentBuilder	environmentBuilder
protected boolean	pause
protected ArrayList<RunListener>	runListeners
protected boolean	step
protected boolean	stop
protected Thread	thread

Constructor Summary

Constructors

Constructor	Description
AbstractRunner()

Method Summary

Modifier and Type	Method	Description
void	addRunListener(RunListener listener)	Adds the specified listener to the list of RunListener-s to be notified of any run related events, such as stopped, started, and so on.
protected void	firePausedMessage()	Fires a paused message to all registered run listeners.
protected void	fireRestartedMessage()	Fires a restarted message to all registered run listeners.
protected void	fireStartedMessage()	Fires a started message to all registered run listeners.
protected void	fireStoppedMessage()	Fires a stopped message to all registered run listeners.
boolean	go()	Specifies if the simulation should continue to run (returns true) or if it should stop (returns false).
void	init()
void	removeRunListener(RunListener listener)	Removes the specified RunListener from the list for RunListener notified by this runner.
void	setController(Controller controller)
void	setEnvironmentBuilder(RunEnvironmentBuilder environment)
void	setPause(boolean pause)
void	step()
void	stop()	Stops the execution of the scheduled events after the any events scheduled for the current tick have been executed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface repast.simphony.engine.graph.Executor

execute

Field Detail

stop

protected boolean stop

pause

protected boolean pause

step

protected boolean step

runListeners

protected ArrayList<RunListener> runListeners

thread

protected Thread thread

environmentBuilder

protected RunEnvironmentBuilder environmentBuilder

controller

protected Controller controller

Constructor Detail

AbstractRunner

public AbstractRunner()

Method Detail

addRunListener

public void addRunListener(RunListener listener)

Adds the specified listener to the list of RunListener-s to be notified of any run related events, such as stopped, started, and so on.

Specified by:

addRunListener in interface Runner

Parameters:

listener - the listener to add.

removeRunListener

public void removeRunListener(RunListener listener)

Description copied from interface: Runner

Removes the specified RunListener from the list for RunListener notified by this runner.

Specified by:

removeRunListener in interface Runner

fireStartedMessage

protected void fireStartedMessage()

Fires a started message to all registered run listeners.

fireStoppedMessage

protected void fireStoppedMessage()

Fires a stopped message to all registered run listeners.

setEnvironmentBuilder

public void setEnvironmentBuilder(RunEnvironmentBuilder environment)

Specified by:

setEnvironmentBuilder in interface Runner

firePausedMessage

protected void firePausedMessage()

Fires a paused message to all registered run listeners.

fireRestartedMessage

protected void fireRestartedMessage()

Fires a restarted message to all registered run listeners.

init

public void init()

Specified by:

init in interface Runner

stop

public void stop()

Stops the execution of the scheduled events after the any events scheduled for the current tick have been executed.

Specified by:

stop in interface Runner

step

public void step()

Specified by:

step in interface Runner

setPause

public void setPause(boolean pause)

Specified by:

setPause in interface Runner

go

public boolean go()

Description copied from interface: Runner

Specifies if the simulation should continue to run (returns true) or if it should stop (returns false).

Specified by:

go in interface Runner

Returns:

true if the runner should keep going

setController

public void setController(Controller controller)

Specified by:

setController in interface Runner