ns3::ListScheduler Class Reference

a std::list event scheduler More...

#include <list-scheduler.h>

Inheritance diagram for ns3::ListScheduler:

Collaboration diagram for ns3::ListScheduler:

Public Member Functions
	ListScheduler ()
virtual	~ListScheduler ()
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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (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)

Private Types
typedef std::list< Event >	Events
typedef std::list< Event > ::iterator	EventsI

Private Attributes
Events	m_events

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoDispose (void)
virtual void	DoStart (void)
virtual void	NotifyNewAggregate (void)

Detailed Description

a std::list event scheduler

This class implements an event scheduler using an std::list data structure, that is, a double linked-list.

This type is not accessible from the Config system.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 40 of file list-scheduler.h.

Member Typedef Documentation

typedef std::list<Event> ns3::ListScheduler::Events

private

Definition at line 55 of file list-scheduler.h.

typedef std::list<Event>::iterator ns3::ListScheduler::EventsI

private

Definition at line 56 of file list-scheduler.h.

Constructor & Destructor Documentation

ns3::ListScheduler::ListScheduler

(

)

Definition at line 45 of file list-scheduler.cc.

References NS_LOG_FUNCTION.

ns3::ListScheduler::~ListScheduler ( )

virtual

Definition at line 49 of file list-scheduler.cc.

Member Function Documentation

TypeId ns3::ListScheduler::GetTypeId ( void  )

static

Reimplemented from ns3::Scheduler.

Definition at line 36 of file list-scheduler.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

void ns3::ListScheduler::Insert ( const Event &  ev )

virtual

Parameters

ev	event to store in the event list

Implements ns3::Scheduler.

Definition at line 54 of file list-scheduler.cc.

References ns3::Scheduler::Event::key, m_events, and NS_LOG_FUNCTION.

bool ns3::ListScheduler::IsEmpty ( void  ) const

virtual

Returns

true if the event list is empty and false otherwise.

Implements ns3::Scheduler.

Definition at line 68 of file list-scheduler.cc.

References m_events, and NS_LOG_FUNCTION.

Scheduler::Event ns3::ListScheduler::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 74 of file list-scheduler.cc.

References m_events, and NS_LOG_FUNCTION.

void ns3::ListScheduler::Remove ( const Event &  ev )

virtual

Parameters

ev	the event to remove

This methods cannot be invoked if the list is empty.

Implements ns3::Scheduler.

Definition at line 90 of file list-scheduler.cc.

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

Scheduler::Event ns3::ListScheduler::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 81 of file list-scheduler.cc.

References m_events, and NS_LOG_FUNCTION.

Member Data Documentation

Events ns3::ListScheduler::m_events

private

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

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

---

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

• src/core/model/list-scheduler.h
• src/core/model/list-scheduler.cc