A Discrete-Event Network Simulator
API
ns3::MapScheduler Class Reference

a std::map event scheduler More...

#include "map-scheduler.h"

+ Inheritance diagram for ns3::MapScheduler:
+ Collaboration diagram for ns3::MapScheduler:

Public Member Functions

 MapScheduler ()
 Constructor. More...
 
virtual ~MapScheduler ()
 Destructor. More...
 
virtual void Insert (const Scheduler::Event &ev)
 Insert a new Event in the schedule. More...
 
virtual bool IsEmpty (void) const
 Test if the schedule is empty. More...
 
virtual Scheduler::Event PeekNext (void) const
 Get a pointer to the next event. More...
 
virtual void Remove (const Scheduler::Event &ev)
 Remove a specific event from the event list. More...
 
virtual Scheduler::Event RemoveNext (void)
 Remove the earliest event from the event list. More...
 
- Public Member Functions inherited from ns3::Scheduler
virtual ~Scheduler ()=0
 Destructor. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () 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< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) 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 (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) 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 erros. 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 (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Scheduler
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Types

typedef std::map< Scheduler::EventKey, EventImpl * > EventMap
 Event list type: a Map from EventKey to EventImpl. More...
 
typedef std::map< Scheduler::EventKey, EventImpl * >::const_iterator EventMapCI
 EventMap const iterator. More...
 
typedef std::map< Scheduler::EventKey, EventImpl * >::iterator EventMapI
 EventMap iterator. More...
 

Private Attributes

EventMap m_list
 The event list. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

a std::map event scheduler

Introspection did not find any typical Config paths.

This class implements the an event scheduler using an std::map data structure.

Time Complexity
Operation Amortized Time Reason
Insert() Logarithmic std::map::insert()
IsEmpty() Constant std::map::empty()
PeekNext() Constant std::map::begin()
Remove() Logarithmic std::map::find()
RemoveNext() Constant std::map::begin()
Memory Complexity
Category Memory Reason
Overhead 3 x sizeof (*) + 2 x size_t
(40 bytes)
red-black tree
Per Event 3 x sizeof (*) + int
(32 bytes)
red-black tree


No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 80 bytes (on a 64-bit architecture).

Definition at line 62 of file map-scheduler.h.

Member Typedef Documentation

◆ EventMap

Event list type: a Map from EventKey to EventImpl.

Definition at line 85 of file map-scheduler.h.

◆ EventMapCI

typedef std::map<Scheduler::EventKey, EventImpl*>::const_iterator ns3::MapScheduler::EventMapCI
private

EventMap const iterator.

Definition at line 89 of file map-scheduler.h.

◆ EventMapI

typedef std::map<Scheduler::EventKey, EventImpl*>::iterator ns3::MapScheduler::EventMapI
private

EventMap iterator.

Definition at line 87 of file map-scheduler.h.

Constructor & Destructor Documentation

◆ MapScheduler()

ns3::MapScheduler::MapScheduler ( )

Constructor.

Definition at line 51 of file map-scheduler.cc.

References NS_LOG_FUNCTION.

◆ ~MapScheduler()

ns3::MapScheduler::~MapScheduler ( )
virtual

Destructor.

Definition at line 55 of file map-scheduler.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetTypeId()

TypeId ns3::MapScheduler::GetTypeId ( void  )
static

Register this type.

Returns
The object TypeId.

Definition at line 41 of file map-scheduler.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Insert()

void ns3::MapScheduler::Insert ( const Scheduler::Event ev)
virtual

Insert a new Event in the schedule.

Parameters
[in]evEvent to store in the event list

Implements ns3::Scheduler.

Definition at line 61 of file map-scheduler.cc.

References ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, m_list, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, NS_ASSERT, NS_LOG_FUNCTION, and test-ns3::result.

◆ IsEmpty()

bool ns3::MapScheduler::IsEmpty ( void  ) const
virtual

Test if the schedule is empty.

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

Implements ns3::Scheduler.

Definition at line 70 of file map-scheduler.cc.

References m_list, and NS_LOG_FUNCTION.

◆ PeekNext()

Scheduler::Event ns3::MapScheduler::PeekNext ( void  ) const
virtual

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 77 of file map-scheduler.cc.

References ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, m_list, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

◆ Remove()

void ns3::MapScheduler::Remove ( const Scheduler::Event ev)
virtual

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 104 of file map-scheduler.cc.

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

◆ RemoveNext()

Scheduler::Event ns3::MapScheduler::RemoveNext ( void  )
virtual

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 90 of file map-scheduler.cc.

References ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, m_list, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_list

EventMap ns3::MapScheduler::m_list
private

The event list.

Definition at line 92 of file map-scheduler.h.

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


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