A Discrete-Event Network Simulator
API
list-scheduler.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #ifndef LIST_SCHEDULER_H
22 #define LIST_SCHEDULER_H
23 
24 #include "scheduler.h"
25 #include <list>
26 #include <utility>
27 #include <stdint.h>
28 
35 namespace ns3 {
36 
37 class EventImpl;
38 
64 class ListScheduler : public Scheduler
65 {
66 public:
71  static TypeId GetTypeId (void);
72 
74  ListScheduler ();
76  virtual ~ListScheduler ();
77 
78  // Inherited
79  virtual void Insert (const Scheduler::Event &ev);
80  virtual bool IsEmpty (void) const;
81  virtual Scheduler::Event PeekNext (void) const;
82  virtual Scheduler::Event RemoveNext (void);
83  virtual void Remove (const Scheduler::Event &ev);
84 
85 private:
87  typedef std::list<Scheduler::Event> Events;
89  typedef std::list<Scheduler::Event>::iterator EventsI;
90 
92  Events m_events;
93 };
94 
95 } // namespace ns3
96 
97 #endif /* LIST_SCHEDULER_H */
ns3::ListScheduler
a std::list event scheduler
Definition: list-scheduler.h:65
ns3::ListScheduler::Insert
virtual void Insert(const Scheduler::Event &ev)
Insert a new Event in the schedule.
Definition: list-scheduler.cc:59
ns3::ListScheduler::RemoveNext
virtual Scheduler::Event RemoveNext(void)
Remove the earliest event from the event list.
Definition: list-scheduler.cc:86
ns3::ListScheduler::~ListScheduler
virtual ~ListScheduler()
Destructor.
Definition: list-scheduler.cc:55
ns3::ListScheduler::PeekNext
virtual Scheduler::Event PeekNext(void) const
Get a pointer to the next event.
Definition: list-scheduler.cc:79
ns3::ListScheduler::EventsI
std::list< Scheduler::Event >::iterator EventsI
Events iterator.
Definition: list-scheduler.h:89
ns3::ListScheduler::Events
std::list< Scheduler::Event > Events
Event list type: a simple list of Events.
Definition: list-scheduler.h:87
ns3::ListScheduler::IsEmpty
virtual bool IsEmpty(void) const
Test if the schedule is empty.
Definition: list-scheduler.cc:73
ns3::ListScheduler::ListScheduler
ListScheduler()
Constructor.
Definition: list-scheduler.cc:51
ns3::ListScheduler::m_events
Events m_events
The event list.
Definition: list-scheduler.h:92
ns3::ListScheduler::GetTypeId
static TypeId GetTypeId(void)
Register this type.
Definition: list-scheduler.cc:41
ns3::ListScheduler::Remove
virtual void Remove(const Scheduler::Event &ev)
Remove a specific event from the event list.
Definition: list-scheduler.cc:95
ns3::Scheduler
Maintain the event list.
Definition: scheduler.h:156
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
scheduler.h
ns3::Scheduler abstract base class, ns3::Scheduler::Event and ns3::Scheduler::EventKey declarations.
ns3::Scheduler::Event
Scheduler event.
Definition: scheduler.h:182