a std::list event scheduler More...
#include <list-scheduler.h>
Inheritance diagram for ns3::ListScheduler:
Collaboration diagram for ns3::ListScheduler:
Public Member Functions | |
| virtual void | Insert (const EventId &id) |
| virtual bool | IsEmpty (void) const |
| virtual EventId | PeekNext (void) const |
| virtual EventId | RemoveNext (void) |
| virtual bool | Remove (const EventId &ev) |
Detailed Description
a std::list event scheduler
This class implements the an event scheduler using an std::list data structure, that is, a double linked-list.
Member Function Documentation
| virtual void ns3::ListScheduler::Insert | ( | const EventId & | id | ) | [virtual] |
- Parameters:
-
id event to store in the event list
This method takes ownership of the event pointer.
Implements ns3::Scheduler.
| virtual bool ns3::ListScheduler::IsEmpty | ( | void | ) | const [virtual] |
- Returns:
- true if the event list is empty and false otherwise.
Implements ns3::Scheduler.
| virtual EventId 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.
| virtual bool ns3::ListScheduler::Remove | ( | const EventId & | id | ) | [virtual] |
- Parameters:
-
id the id of the event to remove
- Returns:
- true if the id was found and removed successfully, false otherwise.
This methods cannot be invoked if the list is empty.
Implements ns3::Scheduler.
| virtual EventId 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.
The documentation for this class was generated from the following file:
- src/simulator/list-scheduler.h
