Event Class Reference

The interface for events which are scheduled in the simulator's event queue. More...

#include <event.hpp>

Inheritance diagram for Event:

List of all members.

Public Types
typedef boost::shared_ptr< Event >	EventPtr
	Smart pointer that clients should use.
Public Member Functions
virtual	~Event ()
	A destructor.
virtual void	execute ()=0
	The code that gets executed for the event.
SimTime	getFireTime () const
	Get the time at which the event will fire.
bool	inEventQueue () const
	True if the event is currently pending in an event queue.
bool	operator< (const Event &e) const
	One event is less than another event if its fire time is smaller.
Protected Member Functions
	Event ()
	A constructor.
Friends
class	Simulator

---

Detailed Description

The interface for events which are scheduled in the simulator's event queue.

Individual sublcasses will override the execute function to do their scheduled action.

Definition at line 19 of file event.hpp.

---

Constructor & Destructor Documentation

Event::~Event

(

)

[virtual]

A destructor.

A virtual destructor is recommended since the class has virtual functions.

Definition at line 9 of file event.cpp.

---

Member Function Documentation

virtual void Event::execute

(

)

[pure virtual]

The code that gets executed for the event.

Subclasses can override this to define their own actions.

Implemented in AppEpochEvent, LayerRecvEvent, DummyEvent, SlottedMacSlotEvent, SendToLinkLayerEvent, SignalRecvEvent, RfidReaderAppReadEvent, RfidMacCycleEvent, and SignalEndEvent.

SimTime Event::getFireTime

(

)

const [inline]

Get the time at which the event will fire.

Returns:

The time at which the event will fire.

Definition at line 102 of file event.hpp.

bool Event::inEventQueue

(

)

const [inline]

True if the event is currently pending in an event queue.

Returns:

true if the event is in an event queue.

Definition at line 107 of file event.hpp.

---

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

• event.hpp
• event.cpp

---