ns3::ListScheduler Class Reference
[Scheduler]

a std::list event scheduler More...

#include <list-scheduler.h>

Inheritance diagram for ns3::ListScheduler:
Inheritance graph
[legend]
Collaboration diagram for ns3::ListScheduler:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ListScheduler ()
virtual ~ListScheduler ()
virtual void Insert (const Event &ev)
virtual bool IsEmpty (void) const
virtual Event PeekNext (void) const
virtual Event RemoveNext (void)
virtual void Remove (const Event &ev)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::ListScheduler.

Private Types

typedef std::list< Event > Events
typedef std::list< Event >
::iterator 
EventsI

Private Attributes

Events m_events

Detailed Description

a std::list event scheduler

This class implements an event scheduler using an std::list data structure, that is, a double linked-list.

Definition at line 40 of file list-scheduler.h.


Member Typedef Documentation

typedef std::list<Event> ns3::ListScheduler::Events [private]

Definition at line 56 of file list-scheduler.h.

typedef std::list<Event>::iterator ns3::ListScheduler::EventsI [private]

Definition at line 57 of file list-scheduler.h.


Constructor & Destructor Documentation

ns3::ListScheduler::ListScheduler (  ) 

Definition at line 37 of file list-scheduler.cc.

ns3::ListScheduler::~ListScheduler (  )  [virtual]

Definition at line 39 of file list-scheduler.cc.


Member Function Documentation

TypeId ns3::ListScheduler::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::ListScheduler.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Scheduler.

Definition at line 28 of file list-scheduler.cc.

void ns3::ListScheduler::Insert ( const Event &  ev  )  [virtual]

Definition at line 43 of file list-scheduler.cc.

bool ns3::ListScheduler::IsEmpty ( void   )  const [virtual]
Returns:
true if the event list is empty and false otherwise.

Implements ns3::Scheduler.

Definition at line 56 of file list-scheduler.cc.

Scheduler::Event ns3::ListScheduler::PeekNext ( void   )  const [virtual]
Returns:
a pointer to the next earliest event. The caller takes ownership of the returned pointer.

This method cannot be invoked if the list is empty.

Implements ns3::Scheduler.

Definition at line 61 of file list-scheduler.cc.

References m_events.

void ns3::ListScheduler::Remove ( const Event &  ev  )  [virtual]

Definition at line 75 of file list-scheduler.cc.

Scheduler::Event ns3::ListScheduler::RemoveNext ( void   )  [virtual]

This method cannot be invoked if the list is empty. Remove the next earliest event from the event list.

Implements ns3::Scheduler.

Definition at line 67 of file list-scheduler.cc.

References m_events.


Member Data Documentation

Definition at line 58 of file list-scheduler.h.

Referenced by PeekNext(), and RemoveNext().


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:12:14 2009 for NS-3 by  doxygen 1.6.3