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. More...

	~PriorityQueueScheduler () override
	Destructor. More...

void	Insert (const Scheduler::Event &ev) override
	Insert a new Event in the schedule. More...

bool	IsEmpty () const override
	Test if the schedule is empty. More...

Scheduler::Event	PeekNext () const override
	Get a pointer to the next event. More...

void	Remove (const Scheduler::Event &ev) override
	Remove a specific event from the event list. More...

Scheduler::Event	RemoveNext () override
	Remove the earliest event from the event list. More...

Public Member Functions inherited from ns3::Scheduler
	~Scheduler () override=0
	Destructor. More...

virtual void	Insert (const Event &ev)=0
	Insert a new Event in the schedule. More...

virtual bool	IsEmpty () const =0
	Test if the schedule is empty. More...

virtual Event	PeekNext () const =0
	Get a pointer to the next event. More...

virtual void	Remove (const Event &ev)=0
	Remove a specific event from the event list. More...

virtual Event	RemoveNext ()=0
	Remove the earliest event from the event list. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

	~Object () override
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose ()
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one. More...

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object. More...

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized () const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount () const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors. More...

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId ()
	Register this type. More...

Static Public Member Functions inherited from ns3::Scheduler
static TypeId	GetTypeId ()
	Register this type. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID. More...

Private Attributes
EventPriorityQueue	m_queue
	The event queue. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoDispose ()
	Destructor implementation. More...

virtual void	DoInitialize ()
	Initialize() implementation. More...

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

a std::priority_queue event scheduler

Introspection did not find any typical Config paths.

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()`