org.volante.abm.schedule

Class DefaultSchedule

java.lang.Object

org.volante.abm.schedule.DefaultSchedule

All Implemented Interfaces:

Schedule, Initialisable

public class DefaultSchedule
extends Object
implements Schedule

Field Summary

Fields

Modifier and Type	Field and Description
protected int	id

Constructor Summary

Constructors

Constructor and Description
DefaultSchedule()
DefaultSchedule(RegionSet regions)

Method Summary

Modifier and Type	Method and Description
void	addStatusListener(ScheduleStatusListener l)
void	finish()
int	getCurrentTick() Returns the current tick (which is the next tick that is performed)
int	getEndTick()
int	getStartTick()
int	getTargetTick()
void	initialise(ModelData data, RunInfo info, Region extent)
void	register(TickAction o) Registers the object in case any actions are going to be called on it e.g.
void	run() Runs the simulation from predefined start to predefined end tick.
void	runFromTo(int start, int end) Runs the simulation from given start to end tick.
void	runUntil(int target) Runs the simulation until the (intermediate) target tick.
void	setEndTick(int end) Sets the simualtion's final tick.
void	setRegions(RegionSet regions)
void	setStartTick(int tick) Sets the simulation's start tick.
void	setTargetTick(int target) Sets and (intermediate) target tick.
void	setTargetToNextTick() Sets the simulation's target tick to the current tick (which is the next tick that is performed).
void	tick() Runs the simulation a single tick.
boolean	unregister(TickAction o) Removes the given TickAction from this schedule to prevent the action from being performed in future.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected int id

Constructor Detail

DefaultSchedule

public DefaultSchedule()

DefaultSchedule

public DefaultSchedule(RegionSet regions)

Method Detail

initialise

public void initialise(ModelData data,
                       RunInfo info,
                       Region extent)
                throws Exception

Specified by:

initialise in interface Initialisable

Parameters:

data - model data

info - run information

extent - region the initialisable object belongs to

Throws:

Exception

tick

public void tick()

Description copied from interface: Schedule

Runs the simulation a single tick.

Specified by:

tick in interface Schedule

finish

public void finish()

Specified by:

finish in interface Schedule

runFromTo

public void runFromTo(int start,
                      int end)

Description copied from interface: Schedule

Runs the simulation from given start to end tick. Overwrites previously set values for start and end ticks.

Specified by:

runFromTo in interface Schedule

See Also:

Schedule.runFromTo(int, int)

runUntil

public void runUntil(int target)

Description copied from interface: Schedule

Runs the simulation until the (intermediate) target tick.

Specified by:

runUntil in interface Schedule

See Also:

Schedule.runUntil(int)

run

public void run()

Description copied from interface: Schedule

Runs the simulation from predefined start to predefined end tick.

Specified by:

run in interface Schedule

See Also:

Schedule.run()

setTargetTick

public void setTargetTick(int target)

Description copied from interface: Schedule

Sets and (intermediate) target tick.

Specified by:

setTargetTick in interface Schedule

See Also:

Schedule.setTargetTick(int)

setEndTick

public void setEndTick(int end)

Description copied from interface: Schedule

Sets the simualtion's final tick.

Specified by:

setEndTick in interface Schedule

See Also:

Schedule.setEndTick(int)

getEndTick

public int getEndTick()

Specified by:

getEndTick in interface Schedule

getTargetTick

public int getTargetTick()

Specified by:

getTargetTick in interface Schedule

getStartTick

public int getStartTick()

Specified by:

getStartTick in interface Schedule

setTargetToNextTick

public void setTargetToNextTick()

Description copied from interface: Schedule

Sets the simulation's target tick to the current tick (which is the next tick that is performed).

Specified by:

setTargetToNextTick in interface Schedule

register

public void register(TickAction o)

Description copied from interface: Schedule

Registers the object in case any actions are going to be called on it e.g. before/after ticks.

Specified by:

register in interface Schedule

unregister

public boolean unregister(TickAction o)

Description copied from interface: Schedule

Removes the given TickAction from this schedule to prevent the action from being performed in future.

Specified by:

unregister in interface Schedule

Parameters:

o - tick action

Returns:

true if the given tick action could be unregistered, false otherwise.

See Also:

Schedule.unregister(org.volante.abm.schedule.TickAction)

setStartTick

public void setStartTick(int tick)

Description copied from interface: Schedule

Sets the simulation's start tick.

Specified by:

setStartTick in interface Schedule

See Also:

Schedule.setStartTick(int)

getCurrentTick

public int getCurrentTick()

Description copied from interface: Schedule

Returns the current tick (which is the next tick that is performed)

Specified by:

getCurrentTick in interface Schedule

Returns:

current tick

setRegions

public void setRegions(RegionSet regions)

Specified by:

setRegions in interface Schedule

addStatusListener

public void addStatusListener(ScheduleStatusListener l)

Specified by:

addStatusListener in interface Schedule