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 ()
 
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)
 This method cannot be invoked if the list is empty. More...
 
- Public Member Functions inherited from ns3::Scheduler
virtual ~Scheduler ()=0
 
- 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
 Implement the GetInstanceTypeId method defined in ObjectBase. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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)
 
- Static Public Member Functions inherited from ns3::Scheduler
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. 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
 
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)
 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.


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 44 of file map-scheduler.h.

Member Typedef Documentation

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

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

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

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

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

Constructor & Destructor Documentation

ns3::MapScheduler::MapScheduler ( )

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

References NS_LOG_FUNCTION.

ns3::MapScheduler::~MapScheduler ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

Definition at line 41 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 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, 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 70 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 77 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 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.

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

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


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