shawn::EventScheduler Class Reference

#include <event_scheduler.h>

Collaboration diagram for shawn::EventScheduler:

[legend]

List of all members.

Local Types
typedef EventInfo *	EventHandle
typedef std::set< EventHandle, EventSorter >	EventSet
static const EventHandle	NO_EVENT
	DECLARE_HANDLES (EventTag)
Public Member Functions
Construction / Destruction
	EventScheduler ()
virtual	~EventScheduler ()
Event Management
EventHandle	new_event (EventHandler &eh, double t, const EventTagHandle &eth) throw ()
void	delete_event (EventHandle) throw ()
void	move_event (EventHandle, double) throw ()
Info Access
double	current_time (void) const throw ()
double	next_event_time (void) const throw ()
bool	empty (void) const throw ()
EventHandle	front_w (void) throw ()
const EventHandle	front (void) const throw ()
Running
void	playback (double stop_time) throw ()
void	clear (double new_time=0.0) throw ()
Classes
class	EventHandler
	Interface for event-handling classes. More...
class	EventInfo
struct	EventSorter
class	EventTag
	Stuff to derive from, thereby adding tagged info to events. More...

---

Member Typedef Documentation

typedef EventInfo* shawn::EventScheduler::EventHandle

typedef std::set<EventHandle,EventSorter> shawn::EventScheduler::EventSet

---

Constructor & Destructor Documentation

shawn::EventScheduler::EventScheduler

(

)

virtual shawn::EventScheduler::~EventScheduler

(

)

[virtual]

---

Member Function Documentation

shawn::EventScheduler::DECLARE_HANDLES

(

EventTag

)

EventHandle shawn::EventScheduler::new_event	(	EventHandler &	eh,
		double	t,
		const EventTagHandle &	eth
	)			throw ()

Creates a new event that timeouts at time t, at which time eh ->timeout() will be called. tag may be NULL or anything the handler might find useful

Returns:

a handle (read: ID) by which the new event is identified

void shawn::EventScheduler::delete_event

(

EventHandle

)

throw ()

Removes the specified event. Must not be called from within timeout() (at least for the timeouting event)

void shawn::EventScheduler::move_event	(	EventHandle	,
		double
	)			throw ()

Re-schedules the event for a different time, abandoning the current one

double shawn::EventScheduler::current_time

(

void

)

const throw ()

double shawn::EventScheduler::next_event_time

(

void

)

const throw ()

bool shawn::EventScheduler::empty

(

void

)

const throw ()

EventHandle shawn::EventScheduler::front_w

(

void

)

throw ()

const EventHandle shawn::EventScheduler::front

(

void

)

const throw ()

void shawn::EventScheduler::playback

(

double

stop_time

)

throw ()

void shawn::EventScheduler::clear

(

double

new_time = 0.0

)

throw ()

---

Member Data Documentation

const EventHandle shawn::EventScheduler::NO_EVENT [static]

---

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

• src/sys/event_scheduler.h