A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::PriorityQueueScheduler Class Reference
Core » Scheduler and Events

a std::priority_queue event scheduler More...

#include "priority-queue-scheduler.h"

+ Inheritance diagram for ns3::PriorityQueueScheduler:
+ Collaboration diagram for ns3::PriorityQueueScheduler:

Classes

class  EventPriorityQueue
 Custom priority_queue which supports remove, and returns entries in increasing time order. More...
 

Public Member Functions

 PriorityQueueScheduler ()
 Constructor.
 
 ~PriorityQueueScheduler () 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.
 
- 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.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- 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, bool permissive=false) 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.
 
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 Attributes

EventPriorityQueue m_queue
 The event queue.
 

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 Symbols inherited from ns3::ObjectBase
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.
 

Detailed Description

a std::priority_queue event scheduler

This class implements an event scheduler using std::priority_queue on a std::vector.

Time Complexity
Operation Amortized Time Reason
Insert() Logarithmic std::push_heap()
IsEmpty() Constant std::vector::empty()
PeekNext() Constant std::vector::front()
Remove() Linear std::find() and std::make_heap()
RemoveNext() Logarithmic std::pop_heap()
Memory Complexity
Category Memory Reason
Overhead 3 x sizeof (*)
(24 bytes) 		std::vector
Per Event 0 Events stored in std::vector directly

Definition at line 54 of file priority-queue-scheduler.h.

Constructor & Destructor Documentation

◆ PriorityQueueScheduler()

ns3::PriorityQueueScheduler::PriorityQueueScheduler ( )

Constructor.

Definition at line 42 of file priority-queue-scheduler.cc.

References NS_LOG_FUNCTION.

◆ ~PriorityQueueScheduler()

ns3::PriorityQueueScheduler::~PriorityQueueScheduler ( )
override

Destructor.

Definition at line 47 of file priority-queue-scheduler.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetTypeId()

TypeId ns3::PriorityQueueScheduler::GetTypeId ( )
static

Register this type.

Returns
The object TypeId.

Definition at line 33 of file priority-queue-scheduler.cc.

References ns3::TypeId::SetParent().

Referenced by SimulatorTestSuite::SimulatorTestSuite().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Insert()

void ns3::PriorityQueueScheduler::Insert ( const Scheduler::Event & ev)
overridevirtual

Insert a new Event in the schedule.

Parameters
[in]evEvent to store in the event list

Implements ns3::Scheduler.

Definition at line 53 of file priority-queue-scheduler.cc.

References ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, m_queue, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, and NS_LOG_FUNCTION.

◆ IsEmpty()

bool ns3::PriorityQueueScheduler::IsEmpty ( ) const
overridevirtual

Test if the schedule is empty.

Returns
true if the event list is empty and false otherwise.

Implements ns3::Scheduler.

Definition at line 60 of file priority-queue-scheduler.cc.

References m_queue, and NS_LOG_FUNCTION.

◆ PeekNext()

Scheduler::Event ns3::PriorityQueueScheduler::PeekNext ( ) const
overridevirtual

Get a pointer to the next event.

This method cannot be invoked if the list is empty.

Returns
A pointer to the next earliest event. The caller takes ownership of the returned pointer.

Implements ns3::Scheduler.

Definition at line 67 of file priority-queue-scheduler.cc.

References m_queue, and NS_LOG_FUNCTION.

◆ Remove()

void ns3::PriorityQueueScheduler::Remove ( const Scheduler::Event & ev)
overridevirtual

Remove a specific event from the event list.

This method cannot be invoked if the list is empty.

Parameters
[in]evThe event to remove

Implements ns3::Scheduler.

Definition at line 99 of file priority-queue-scheduler.cc.

References m_queue, NS_LOG_FUNCTION, and ns3::PriorityQueueScheduler::EventPriorityQueue::remove().

+ Here is the call graph for this function:

◆ RemoveNext()

Scheduler::Event ns3::PriorityQueueScheduler::RemoveNext ( )
overridevirtual

Remove the earliest event from the event list.

This method cannot be invoked if the list is empty.

Returns
The Event.

Implements ns3::Scheduler.

Definition at line 74 of file priority-queue-scheduler.cc.

References m_queue, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_queue

EventPriorityQueue ns3::PriorityQueueScheduler::m_queue
private

The event queue.

Definition at line 94 of file priority-queue-scheduler.h.

Referenced by Insert(), IsEmpty(), PeekNext(), Remove(), and RemoveNext().

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