repast::ScheduleRunner Class Reference

Runs the Schedule by popping events off of the Schedule and executing them; also provides methods for scheduling events. More...

#include <Schedule.h>

Inheritance diagram for repast::ScheduleRunner:

Public Member Functions
	ScheduleRunner (boost::mpi::communicator *communicator)
ScheduledEvent *	scheduleEvent (double at, Schedule::FunctorPtr func)
	Schedules the Functor to execute at the specified tick. More...
ScheduledEvent *	scheduleEvent (double start, double interval, Schedule::FunctorPtr func)
	Schedules the Functor to execute at the specified start tick and every interval thereafter. More...
void	scheduleEndEvent (Schedule::FunctorPtr func)
	Schedules the specified functor to execute when the simulation ends. More...
void	scheduleStop (double at)
	Schedules the simulation to stop at the specified tick. More...
void	run ()
	Starts and runs the simulation schedule.
double	currentTick ()
	Gets the current tick. More...
void	stop ()
	Stops the simulation.
const Schedule &	schedule ()
	Gets the schedule executed by this simulation runner. More...

Detailed Description

Runs the Schedule by popping events off of the Schedule and executing them; also provides methods for scheduling events.

Simulation events should be scheduled for execution using this class which is accessible via RepastProcess::instance()->getScheduleRunner()

Member Function Documentation

currentTick()

double repast::ScheduleRunner::currentTick ( )

inline

Gets the current tick.

Returns

the current tick

schedule()

const Schedule& repast::ScheduleRunner::schedule ( )

inline

Gets the schedule executed by this simulation runner.

Returns

the schedule used by this simulation runner.

scheduleEndEvent()

void repast::ScheduleRunner::scheduleEndEvent

(

Schedule::FunctorPtr

func

)

Schedules the specified functor to execute when the simulation ends.

Parameters

func	the functor to execute when the simulatione ends

scheduleEvent() [1/2]

ScheduledEvent * repast::ScheduleRunner::scheduleEvent	(	double	at,
		Schedule::FunctorPtr	func
	)

Schedules the Functor to execute at the specified tick.

Parameters

at	the time to execute at
func	the functor to execute

Returns

the event that was scheduled for the func

scheduleEvent() [2/2]

ScheduledEvent * repast::ScheduleRunner::scheduleEvent	(	double	start,
		double	interval,
		Schedule::FunctorPtr	func
	)

Schedules the Functor to execute at the specified start tick and every interval thereafter.

Parameters

start	the time to start at
interval	the interval to execute at
func	the functor to execute

Returns

the event that was scheduled for the func

scheduleStop()

void repast::ScheduleRunner::scheduleStop

(

double

at

)

Schedules the simulation to stop at the specified tick.

Parameters

at	the tick at which the simulation should stop

---

The documentation for this class was generated from the following files:

• /home/nick/Documents/repos/repast.hpc/src/repast_hpc/Schedule.h
• /home/nick/Documents/repos/repast.hpc/src/repast_hpc/Schedule.cpp