Interface ScheduleRegistry
-
- All Known Implementing Classes:
DefaultScheduleRegistry
public interface ScheduleRegistry
A registry containing schedule related objects. This is used by RunState and therefore can be used by Controller actions to retrieve schedules and store actions that are to occur.- Version:
- $Revision: 1.1 $ $Date: 2005/12/21 22:25:34 $
- Author:
- Jerry Vos
- See Also:
RunState
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addPostRunAction(IAction action)
Adds an action that should occur after a run of the model schedule.void
addPreRunAction(IAction action)
Adds an action that should occur before a run of the model schedule.ISchedule
getModelSchedule()
Retrieves the schedule that models should use to schedule their actions.Iterable<IAction>
getPostRunActions()
Retrieves the actions that are to occur after a run of the model schedule.Iterable<IAction>
getPreRunActions()
Retrieves the actions that are to occur before a run of the model schedule.Runner
getScheduleRunner()
Retrieves the runner used for executing the schedule.void
removePostRunAction(IAction action)
Removes an action from the actions that should occur after a run of the model schedule.void
removePreRunAction(IAction action)
Removes an action from the actions that should occur before a run of the model schedule.void
setModelSchedule(ISchedule modelSchedule)
Sets the schedule users should use to schedule their actions.void
setScheduleRunner(Runner runner)
Sets the runner used for executing the schedule.
-
-
-
Method Detail
-
getModelSchedule
ISchedule getModelSchedule()
Retrieves the schedule that models should use to schedule their actions.- Returns:
- the schedule to be used used by models
-
setModelSchedule
void setModelSchedule(ISchedule modelSchedule)
Sets the schedule users should use to schedule their actions. Users should not use this method as it is intended for internal Repast use. If a user would like a custom schedule to be used they should specify a ScheduleFactory to the Controller.- Parameters:
modelSchedule
- the schedule used by models
-
getPreRunActions
Iterable<IAction> getPreRunActions()
Retrieves the actions that are to occur before a run of the model schedule.- Returns:
- the actions that are to occur before a run of the model schedule
-
addPreRunAction
void addPreRunAction(IAction action)
Adds an action that should occur before a run of the model schedule.- Parameters:
action
- an action that should occur before a run of the model schedule
-
removePreRunAction
void removePreRunAction(IAction action)
Removes an action from the actions that should occur before a run of the model schedule.- Parameters:
action
- an action that should occur before a run of the model schedule
-
getPostRunActions
Iterable<IAction> getPostRunActions()
Retrieves the actions that are to occur after a run of the model schedule.- Returns:
- the actions that are to occur after a run of the model schedule
-
addPostRunAction
void addPostRunAction(IAction action)
Adds an action that should occur after a run of the model schedule.- Parameters:
action
- an action that should occur after a run of the model schedule
-
removePostRunAction
void removePostRunAction(IAction action)
Removes an action from the actions that should occur after a run of the model schedule.- Parameters:
action
- an action that should occur after a run of the model schedule
-
setScheduleRunner
void setScheduleRunner(Runner runner)
Sets the runner used for executing the schedule.- Parameters:
runner
- the schedule runner
-
getScheduleRunner
Runner getScheduleRunner()
Retrieves the runner used for executing the schedule.- Parameters:
runner
- the schedule runner
-
-