ns3::DefaultSimulatorImpl Class Reference

#include <default-simulator-impl.h>

Inheritance diagram for ns3::DefaultSimulatorImpl:

Collaboration diagram for ns3::DefaultSimulatorImpl:

Classes
struct	EventWithContext

Public Member Functions
	DefaultSimulatorImpl ()
	~DefaultSimulatorImpl ()
virtual void	Cancel (const EventId &ev)
virtual void	Destroy ()
virtual uint32_t	GetContext (void) const
virtual Time	GetDelayLeft (const EventId &id) const
virtual Time	GetMaximumSimulationTime (void) const
virtual uint32_t	GetSystemId (void) const
virtual bool	IsExpired (const EventId &ev) const
virtual bool	IsFinished (void) const
virtual Time	Now (void) const
virtual void	Remove (const EventId &ev)
virtual void	Run (void)
virtual EventId	Schedule (Time const &time, EventImpl *event)
virtual EventId	ScheduleDestroy (EventImpl *event)
virtual EventId	ScheduleNow (EventImpl *event)
virtual void	ScheduleWithContext (uint32_t context, Time const &time, EventImpl *event)
virtual void	SetScheduler (ObjectFactory schedulerFactory)
virtual void	Stop (void)
virtual void	Stop (Time const &time)

Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::DefaultSimulatorImpl.

Private Types
typedef std::list< EventId >	DestroyEvents
typedef std::list< struct EventWithContext >	EventsWithContext

Private Member Functions
virtual void	DoDispose (void)
void	ProcessEventsWithContext (void)
void	ProcessOneEvent (void)

Private Attributes
uint32_t	m_currentContext
uint64_t	m_currentTs
uint32_t	m_currentUid
DestroyEvents	m_destroyEvents
Ptr< Scheduler >	m_events
EventsWithContext	m_eventsWithContext
bool	m_eventsWithContextEmpty
SystemMutex	m_eventsWithContextMutex
SystemThread::ThreadId	m_main
bool	m_stop
uint32_t	m_uid
int	m_unscheduledEvents

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

Definition at line 36 of file default-simulator-impl.h.

Member Typedef Documentation

typedef std::list<EventId> ns3::DefaultSimulatorImpl::DestroyEvents

private

Definition at line 78 of file default-simulator-impl.h.

typedef std::list<struct EventWithContext> ns3::DefaultSimulatorImpl::EventsWithContext

private

Definition at line 73 of file default-simulator-impl.h.

Constructor & Destructor Documentation

ns3::DefaultSimulatorImpl::DefaultSimulatorImpl

(

)

Definition at line 49 of file default-simulator-impl.cc.

References m_currentContext, m_currentTs, m_currentUid, m_eventsWithContextEmpty, m_main, m_stop, m_uid, m_unscheduledEvents, and ns3::SystemThread::Self().

Here is the call graph for this function:

ns3::DefaultSimulatorImpl::~DefaultSimulatorImpl

(

)

Definition at line 66 of file default-simulator-impl.cc.

Member Function Documentation

void ns3::DefaultSimulatorImpl::Cancel ( const EventId &  ev )

virtual

Set the cancel bit on this event: the event's associated function will not be invoked when it expires. This method has the same visible effect as the ns3::Simulator::remove method but its algorithmic complexity is much lower: it has O(1) complexity. This method has the exact same semantics as ns3::EventId::cancel. Note that it is not possible to cancel events which were scheduled for the "destroy" time. Doing so will result in a program error (crash).

Parameters

ev	the event to cancel

Implements ns3::SimulatorImpl.

Definition at line 337 of file default-simulator-impl.cc.

References IsExpired().

Here is the call graph for this function:

void ns3::DefaultSimulatorImpl::Destroy ( )

virtual

Every event scheduled by the Simulator::insertAtDestroy method is invoked. Then, we ensure that any memory allocated by the Simulator is freed. This method is typically invoked at the end of a simulation to avoid false-positive reports by a leak checker. After this method has been invoked, it is actually possible to restart a new simulation with a set of calls to Simulator::run and Simulator::insert_*.

Implements ns3::SimulatorImpl.

Definition at line 82 of file default-simulator-impl.cc.

References ns3::EventImpl::Invoke(), ns3::EventImpl::IsCancelled(), m_destroyEvents, and NS_LOG_LOGIC.

Here is the call graph for this function:

void ns3::DefaultSimulatorImpl::DoDispose ( void  )

privatevirtual

Definition at line 71 of file default-simulator-impl.cc.

References ns3::Scheduler::Event::impl, ns3::Scheduler::IsEmpty(), m_events, ns3::Scheduler::RemoveNext(), and ns3::SimpleRefCount< T, PARENT, DELETER >::Unref().

Here is the call graph for this function:

uint32_t ns3::DefaultSimulatorImpl::GetContext ( void  ) const

virtual

Returns

the current simulation context

Implements ns3::SimulatorImpl.

Definition at line 388 of file default-simulator-impl.cc.

References m_currentContext.

Referenced by Schedule(), and ScheduleNow().

Here is the caller graph for this function:

Time ns3::DefaultSimulatorImpl::GetDelayLeft ( const EventId &  id ) const

virtual

Parameters

id	the event id to analyse

Returns

the delay left until the input event id expires. if the event is not running, this method returns zero.

Implements ns3::SimulatorImpl.

Definition at line 291 of file default-simulator-impl.cc.

References IsExpired(), m_currentTs, and ns3::TimeStep().

Here is the call graph for this function:

Time ns3::DefaultSimulatorImpl::GetMaximumSimulationTime ( void  ) const

virtual

Returns

the maximum simulation time at which an event can be scheduled.

The returned value will always be bigger than or equal to Simulator::Now.

Implements ns3::SimulatorImpl.

Definition at line 380 of file default-simulator-impl.cc.

References ns3::TimeStep().

Here is the call graph for this function:

uint32_t ns3::DefaultSimulatorImpl::GetSystemId ( void  ) const

virtual

Returns

the system id for this simulator; used for MPI or other distributed simulations

Implements ns3::SimulatorImpl.

Definition at line 114 of file default-simulator-impl.cc.

TypeId ns3::DefaultSimulatorImpl::GetTypeId ( void  )

static

This method returns the TypeId associated to ns3::DefaultSimulatorImpl.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::SimulatorImpl.

Definition at line 40 of file default-simulator-impl.cc.

References ns3::TypeId::SetParent().

Referenced by ns3::anonymous_namespace{visual-simulator-impl.cc}::GetDefaultSimulatorImplFactory().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::DefaultSimulatorImpl::IsExpired ( const EventId &  ev ) const

virtual

This method has O(1) complexity. Note that it is not possible to test for the expiration of events which were scheduled for the "destroy" time. Doing so will result in a program error (crash). An event is said to "expire" when it starts being scheduled which means that if the code executed by the event calls this function, it will get true.

Parameters

ev	the event to test for expiration

Returns

true if the event has expired, false otherwise.

Implements ns3::SimulatorImpl.

Definition at line 346 of file default-simulator-impl.cc.

References ns3::EventId::GetTs(), ns3::EventId::GetUid(), ns3::EventImpl::IsCancelled(), m_currentTs, m_currentUid, m_destroyEvents, and ns3::EventId::PeekEventImpl().

Referenced by Cancel(), GetDelayLeft(), and Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::DefaultSimulatorImpl::IsFinished ( void  ) const

virtual

If there are no more events lefts to be scheduled, or if simulation time has already reached the "stop time" (see Simulator::Stop()), return true. Return false otherwise.

Implements ns3::SimulatorImpl.

Definition at line 138 of file default-simulator-impl.cc.

References ns3::Scheduler::IsEmpty(), m_events, and m_stop.

Here is the call graph for this function:

Time ns3::DefaultSimulatorImpl::Now ( void  ) const

virtual

Return the "current simulation time".

Implements ns3::SimulatorImpl.

Definition at line 285 of file default-simulator-impl.cc.

References m_currentTs, and ns3::TimeStep().

Here is the call graph for this function:

void ns3::DefaultSimulatorImpl::ProcessEventsWithContext ( void  )

private

Definition at line 144 of file default-simulator-impl.cc.

References ns3::Scheduler::Event::impl, ns3::Scheduler::Insert(), ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, m_eventsWithContext, m_eventsWithContextEmpty, m_eventsWithContextMutex, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_uid, and m_unscheduledEvents.

Referenced by ProcessOneEvent(), and Run().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::DefaultSimulatorImpl::ProcessOneEvent ( void  )

private

Definition at line 120 of file default-simulator-impl.cc.

References ns3::Scheduler::Event::impl, ns3::EventImpl::Invoke(), ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentContext, m_currentTs, m_currentUid, m_events, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_unscheduledEvents, NS_ASSERT, NS_LOG_LOGIC, ProcessEventsWithContext(), ns3::Scheduler::RemoveNext(), and ns3::SimpleRefCount< T, PARENT, DELETER >::Unref().

Referenced by Run().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::DefaultSimulatorImpl::Remove ( const EventId &  ev )

virtual

Remove an event from the event list. This method has the same visible effect as the ns3::EventId::Cancel method but its algorithmic complexity is much higher: it has often O(log(n)) complexity, sometimes O(n), sometimes worse. Note that it is not possible to remove events which were scheduled for the "destroy" time. Doing so will result in a program error (crash).

Parameters

ev	the event to remove from the list of scheduled events.

Implements ns3::SimulatorImpl.

Definition at line 304 of file default-simulator-impl.cc.

References ns3::Scheduler::Event::impl, IsExpired(), m_destroyEvents, m_events, m_unscheduledEvents, and ns3::Scheduler::Remove().

Here is the call graph for this function:

void ns3::DefaultSimulatorImpl::Run ( void  )

virtual

Run the simulation until one of:

• no events are present anymore
• the user called Simulator::stop
• the user called Simulator::stopAtUs and the expiration time of the next event to be processed is greater than or equal to the stop time.

Implements ns3::SimulatorImpl.

Definition at line 174 of file default-simulator-impl.cc.

References ns3::Scheduler::IsEmpty(), m_events, m_main, m_stop, m_unscheduledEvents, NS_ASSERT, ProcessEventsWithContext(), ProcessOneEvent(), and ns3::SystemThread::Self().

Here is the call graph for this function:

EventId ns3::DefaultSimulatorImpl::Schedule ( Time const &  time, EventImpl *  event  )

virtual

Parameters

time	delay until the event expires
event	the event to schedule

Returns

a unique identifier for the newly-scheduled event.

This method will be typically used by language bindings to delegate events to their own subclass of the EventImpl base class.

Implements ns3::SimulatorImpl.

Definition at line 207 of file default-simulator-impl.cc.

References ns3::SystemThread::Equals(), GetContext(), ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, ns3::Scheduler::Insert(), ns3::Time::IsPositive(), ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, m_main, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_uid, m_unscheduledEvents, NS_ASSERT, NS_ASSERT_MSG, and ns3::TimeStep().

Referenced by Stop().

Here is the call graph for this function:

Here is the caller graph for this function:

EventId ns3::DefaultSimulatorImpl::ScheduleDestroy ( EventImpl *  event )

virtual

Parameters

event

the event to schedule

Returns

a unique identifier for the newly-scheduled event.

This method will be typically used by language bindings to delegate events to their own subclass of the EventImpl base class.

Implements ns3::SimulatorImpl.

Definition at line 274 of file default-simulator-impl.cc.

References ns3::SystemThread::Equals(), m_currentTs, m_destroyEvents, m_main, m_uid, and NS_ASSERT_MSG.

Here is the call graph for this function:

EventId ns3::DefaultSimulatorImpl::ScheduleNow ( EventImpl *  event )

virtual

Parameters

event

the event to schedule

Returns

a unique identifier for the newly-scheduled event.

This method will be typically used by language bindings to delegate events to their own subclass of the EventImpl base class.

Implements ns3::SimulatorImpl.

Definition at line 258 of file default-simulator-impl.cc.

References ns3::SystemThread::Equals(), GetContext(), ns3::Scheduler::Event::impl, ns3::Scheduler::Insert(), ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, m_main, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_uid, m_unscheduledEvents, and NS_ASSERT_MSG.

Here is the call graph for this function:

void ns3::DefaultSimulatorImpl::ScheduleWithContext ( uint32_t  context, Time const &  time, EventImpl *  event  )

virtual

Parameters

time	delay until the event expires
context	event context
event	the event to schedule

Returns

a unique identifier for the newly-scheduled event.

This method will be typically used by language bindings to delegate events to their own subclass of the EventImpl base class.

Implements ns3::SimulatorImpl.

Definition at line 227 of file default-simulator-impl.cc.

References ns3::DefaultSimulatorImpl::EventWithContext::context, ns3::SystemThread::Equals(), ns3::DefaultSimulatorImpl::EventWithContext::event, ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, ns3::Scheduler::Insert(), ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, m_eventsWithContext, m_eventsWithContextEmpty, m_eventsWithContextMutex, m_main, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_uid, m_unscheduledEvents, NS_LOG_FUNCTION, ns3::DefaultSimulatorImpl::EventWithContext::timestamp, and ns3::TimeStep().

Here is the call graph for this function:

void ns3::DefaultSimulatorImpl::SetScheduler ( ObjectFactory  schedulerFactory )

virtual

Parameters

schedulerFactory

a new event scheduler factory

The event scheduler can be set at any time: the events scheduled in the previous scheduler will be transfered to the new scheduler before we start to use it.

Implements ns3::SimulatorImpl.

Definition at line 97 of file default-simulator-impl.cc.

References ns3::ObjectFactory::Create(), ns3::Scheduler::Insert(), ns3::Scheduler::IsEmpty(), m_events, and ns3::Scheduler::RemoveNext().

Here is the call graph for this function:

void ns3::DefaultSimulatorImpl::Stop ( void  )

virtual

If an event invokes this method, it will be the last event scheduled by the Simulator::run method before returning to the caller.

Implements ns3::SimulatorImpl.

Definition at line 192 of file default-simulator-impl.cc.

References m_stop.

void ns3::DefaultSimulatorImpl::Stop ( Time const &  time )

virtual

Force the Simulator::run method to return to the caller when the expiration time of the next event to be processed is greater than or equal to the stop time. The stop time is relative to the current simulation time.

Parameters

time	the stop time, relative to the current time.

Implements ns3::SimulatorImpl.

Definition at line 198 of file default-simulator-impl.cc.

References Schedule(), and ns3::Simulator::Stop().

Here is the call graph for this function:

Member Data Documentation

uint32_t ns3::DefaultSimulatorImpl::m_currentContext

private

Definition at line 86 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), GetContext(), and ProcessOneEvent().

uint64_t ns3::DefaultSimulatorImpl::m_currentTs

private

Definition at line 85 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), GetDelayLeft(), IsExpired(), Now(), ProcessEventsWithContext(), ProcessOneEvent(), Schedule(), ScheduleDestroy(), ScheduleNow(), and ScheduleWithContext().

uint32_t ns3::DefaultSimulatorImpl::m_currentUid

private

Definition at line 84 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), IsExpired(), and ProcessOneEvent().

DestroyEvents ns3::DefaultSimulatorImpl::m_destroyEvents

private

Definition at line 79 of file default-simulator-impl.h.

Referenced by Destroy(), IsExpired(), Remove(), and ScheduleDestroy().

Ptr<Scheduler> ns3::DefaultSimulatorImpl::m_events

private

Definition at line 81 of file default-simulator-impl.h.

Referenced by DoDispose(), IsFinished(), ProcessEventsWithContext(), ProcessOneEvent(), Remove(), Run(), Schedule(), ScheduleNow(), ScheduleWithContext(), and SetScheduler().

EventsWithContext ns3::DefaultSimulatorImpl::m_eventsWithContext

private

Definition at line 74 of file default-simulator-impl.h.

Referenced by ProcessEventsWithContext(), and ScheduleWithContext().

bool ns3::DefaultSimulatorImpl::m_eventsWithContextEmpty

private

Definition at line 75 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), ProcessEventsWithContext(), and ScheduleWithContext().

SystemMutex ns3::DefaultSimulatorImpl::m_eventsWithContextMutex

private

Definition at line 76 of file default-simulator-impl.h.

Referenced by ProcessEventsWithContext(), and ScheduleWithContext().

SystemThread::ThreadId ns3::DefaultSimulatorImpl::m_main

private

Definition at line 91 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), Run(), Schedule(), ScheduleDestroy(), ScheduleNow(), and ScheduleWithContext().

bool ns3::DefaultSimulatorImpl::m_stop

private

Definition at line 80 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), IsFinished(), Run(), and Stop().

uint32_t ns3::DefaultSimulatorImpl::m_uid

private

Definition at line 83 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), ProcessEventsWithContext(), Schedule(), ScheduleDestroy(), ScheduleNow(), and ScheduleWithContext().

int ns3::DefaultSimulatorImpl::m_unscheduledEvents

private

Definition at line 89 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), ProcessEventsWithContext(), ProcessOneEvent(), Remove(), Run(), Schedule(), ScheduleNow(), and ScheduleWithContext().

---

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

• src/core/model/default-simulator-impl.h
• doc/introspected-doxygen.h
• src/core/model/default-simulator-impl.cc