org.volante.abm.schedule

Interface Schedule

All Superinterfaces:

Initialisable

All Known Implementing Classes:

DefaultSchedule

public interface Schedule
extends Initialisable

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	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 end) Runs the simulation until the (intermediate) target tick.
void	setEndTick(int end) Sets the simualtion's final tick.
void	setRegions(RegionSet set)
void	setStartTick(int start) 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 interface org.volante.abm.serialization.Initialisable

initialise

Method Detail

tick

void tick()

Runs the simulation a single tick.

setTargetToNextTick

void setTargetToNextTick()

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

getCurrentTick

int getCurrentTick()

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

Returns:

current tick

register

void register(TickAction o)

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

Parameters:

o -

unregister

boolean unregister(TickAction o)

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

Parameters:

o - tick action

Returns:

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

setRegions

void setRegions(RegionSet set)

setStartTick

void setStartTick(int start)

Sets the simulation's start tick.

Parameters:

start -

setTargetTick

void setTargetTick(int target)

Sets and (intermediate) target tick.

Parameters:

target -

setEndTick

void setEndTick(int end)

Sets the simualtion's final tick.

Parameters:

end -

getTargetTick

int getTargetTick()

getStartTick

int getStartTick()

getEndTick

int getEndTick()

run

void run()

Runs the simulation from predefined start to predefined end tick.

runUntil

void runUntil(int end)

Runs the simulation until the (intermediate) target tick.

Parameters:

end -

runFromTo

void runFromTo(int start,
               int end)

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

Parameters:

start -

end -

finish

void finish()

addStatusListener

void addStatusListener(ScheduleStatusListener l)