a std::list event scheduler More...
#include "list-scheduler.h"
Public Member Functions | |
ListScheduler () | |
Constructor. | |
~ListScheduler () override | |
Destructor. | |
void | Insert (const Scheduler::Event &ev) override |
Insert a new Event in the schedule. | |
bool | IsEmpty () const override |
Test if the schedule is empty. | |
Scheduler::Event | PeekNext () const override |
Get a pointer to the next event. | |
void | Remove (const Scheduler::Event &ev) override |
Remove a specific event from the event list. | |
Scheduler::Event | RemoveNext () override |
Remove the earliest event from the event list. | |
Public Member Functions inherited from ns3::Scheduler | |
~Scheduler () override=0 | |
Destructor. | |
virtual void | Insert (const Event &ev)=0 |
Insert a new Event in the schedule. | |
virtual bool | IsEmpty () const =0 |
Test if the schedule is empty. | |
virtual Event | PeekNext () const =0 |
Get a pointer to the next event. | |
virtual void | Remove (const Event &ev)=0 |
Remove a specific event from the event list. | |
virtual Event | RemoveNext ()=0 |
Remove the earliest event from the event list. | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::Scheduler | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Types | |
typedef std::list< Scheduler::Event > | Events |
Event list type: a simple list of Events. | |
typedef std::list< Scheduler::Event >::iterator | EventsI |
Events iterator. | |
Private Attributes | |
Events | m_events |
The event list. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
a std::list event scheduler
Introspection did not find any typical Config paths.
This class implements an event scheduler using an std::list data structure, that is, a double linked-list.
Operation | Amortized Time | Reason |
---|---|---|
Insert() | Linear | Linear search in std::list |
IsEmpty() | Constant | std::list::size() |
PeekNext() | Constant | std::list::front() |
Remove() | Linear | Linear search in std::list |
RemoveNext() | Constant | std::list::pop_front() |
Category | Memory | Reason |
---|---|---|
Overhead | 2 x sizeof (*) + size_t (24 bytes) | std::list |
Per Event | 2 x sizeof (*) | std::list |
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 48 bytes (on a 64-bit architecture).
Definition at line 65 of file list-scheduler.h.
|
private |
Event list type: a simple list of Events.
Definition at line 88 of file list-scheduler.h.
|
private |
Events iterator.
Definition at line 90 of file list-scheduler.h.
ns3::ListScheduler::ListScheduler | ( | ) |
|
override |
Destructor.
Definition at line 57 of file list-scheduler.cc.
|
static |
Register this type.
Definition at line 43 of file list-scheduler.cc.
References ns3::TypeId::SetParent().
Referenced by SimulatorTestSuite::SimulatorTestSuite().
|
overridevirtual |
Insert a new Event in the schedule.
[in] | ev | Event to store in the event list |
Implements ns3::Scheduler.
Definition at line 62 of file list-scheduler.cc.
References ns3::Scheduler::Event::key, m_events, and NS_LOG_FUNCTION.
|
overridevirtual |
Test if the schedule is empty.
true
if the event list is empty and false
otherwise. Implements ns3::Scheduler.
Definition at line 77 of file list-scheduler.cc.
References m_events, and NS_LOG_FUNCTION.
|
overridevirtual |
Get a pointer to the next event.
This method cannot be invoked if the list is empty.
Implements ns3::Scheduler.
Definition at line 84 of file list-scheduler.cc.
References m_events, and NS_LOG_FUNCTION.
|
overridevirtual |
Remove a specific event from the event list.
This method cannot be invoked if the list is empty.
[in] | ev | The event to remove |
Implements ns3::Scheduler.
Definition at line 100 of file list-scheduler.cc.
References ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, m_events, ns3::Scheduler::EventKey::m_uid, NS_ASSERT, and NS_LOG_FUNCTION.
|
overridevirtual |
Remove the earliest event from the event list.
This method cannot be invoked if the list is empty.
Implements ns3::Scheduler.
Definition at line 91 of file list-scheduler.cc.
References m_events, and NS_LOG_FUNCTION.
|
private |
The event list.
Definition at line 93 of file list-scheduler.h.
Referenced by Insert(), IsEmpty(), PeekNext(), Remove(), and RemoveNext().