A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 ()
 
virtual ~MapScheduler ()
 
virtual void Insert (const Event &ev)
 
virtual bool IsEmpty (void) const
 
virtual Event PeekNext (void) const
 
virtual void Remove (const Event &ev)
 
virtual Event RemoveNext (void)
 
- Public Member Functions inherited from ns3::Scheduler
virtual ~Scheduler ()=0
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Scheduler
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Types

typedef std::map
< Scheduler::EventKey,
EventImpl * > 
EventMap
 
typedef std::map
< Scheduler::EventKey,
EventImpl * >::const_iterator 
EventMapCI
 
typedef std::map
< Scheduler::EventKey,
EventImpl * >::iterator 
EventMapI
 

Private Attributes

EventMap m_list
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

a std::map event scheduler

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

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Member Typedef Documentation

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

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

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

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

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

Constructor & Destructor Documentation

ns3::MapScheduler::MapScheduler ( )

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

References NS_LOG_FUNCTION.

ns3::MapScheduler::~MapScheduler ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::MapScheduler::Insert ( const Event ev)
virtual
Parameters
evevent to store in the event list

Implements ns3::Scheduler.

Definition at line 54 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.

bool ns3::MapScheduler::IsEmpty ( void  ) const
virtual
Returns
true if the event list is empty and false otherwise.

Implements ns3::Scheduler.

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

References m_list, and NS_LOG_FUNCTION.

Scheduler::Event ns3::MapScheduler::PeekNext ( void  ) const
virtual
Returns
a pointer to the next earliest event. The caller takes ownership of the returned pointer.

This method cannot be invoked if the list is empty.

Implements ns3::Scheduler.

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

References ns3::Scheduler::Event::impl, m_list, NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

void ns3::MapScheduler::Remove ( const Event ev)
virtual
Parameters
evthe event to remove

This methods cannot be invoked if the list is empty.

Implements ns3::Scheduler.

Definition at line 97 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.

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

This method cannot be invoked if the list is empty. Remove the next earliest event from the event list.

Implements ns3::Scheduler.

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

References ns3::Scheduler::Event::impl, m_list, NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Member Data Documentation

EventMap ns3::MapScheduler::m_list
private

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

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


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