A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ns3::DefaultSimulatorImpl Class Reference
Simulator

Doxygen introspection did not find any typical Config paths. More...

#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)
 Set the cancel bit on this event: the event's associated function will not be invoked when it expires. More...
 
virtual void Destroy ()
 This method is typically invoked at the end of a simulation to avoid false-positive reports by a leak checker. More...
 
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
 This method has O(1) complexity. More...
 
virtual bool IsFinished (void) const
 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. More...
 
virtual Time Now (void) const
 Return the "current simulation time". More...
 
virtual void Remove (const EventId &ev)
 Remove an event from the event list. More...
 
virtual void Run (void)
 Run the simulation until one of: More...
 
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)
 If an event invokes this method, it will be the last event scheduled by the Simulator::Run method before returning to the caller. More...
 
virtual void Stop (Time const &time)
 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. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. 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...
 
SimpleRefCount & operator= (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
 
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::SimulatorImpl
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::list< EventId > DestroyEvents
 
typedef std::list< struct
EventWithContext > 		EventsWithContext
 

Private Member Functions

virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
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 DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

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 39 of file default-simulator-impl.h.

Member Typedef Documentation

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

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

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

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

Constructor & Destructor Documentation

ns3::DefaultSimulatorImpl::DefaultSimulatorImpl ( )

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

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

+ Here is the call graph for this function:

ns3::DefaultSimulatorImpl::~DefaultSimulatorImpl ( )

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

References NS_LOG_FUNCTION.

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
evthe event to cancel

Implements ns3::SimulatorImpl.

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

References IsExpired().

+ Here is the call graph for this function:

void ns3::DefaultSimulatorImpl::Destroy ( )
virtual

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, Simulator::Schedule and Simulator::ScheduleWithContext.

Implements ns3::SimulatorImpl.

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

References m_destroyEvents, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

void ns3::DefaultSimulatorImpl::DoDispose ( void  )
privatevirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

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

References ns3::Object::DoDispose(), ns3::Scheduler::Event::impl, m_events, NS_LOG_FUNCTION, 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 403 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
idthe 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 306 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.

Todo:
I am fairly certain other compilers use other non-standard post-fixes to indicate 64 bit constants.

Implements ns3::SimulatorImpl.

Definition at line 395 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 124 of file default-simulator-impl.cc.

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

Definition at line 45 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
evthe event to test for expiration
Returns
true if the event has expired, false otherwise.

Implements ns3::SimulatorImpl.

Definition at line 361 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 148 of file default-simulator-impl.cc.

References m_events, and m_stop.

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

Return the "current simulation time".

Implements ns3::SimulatorImpl.

Definition at line 299 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 154 of file default-simulator-impl.cc.

References ns3::Scheduler::Event::impl, 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 caller graph for this function:

void ns3::DefaultSimulatorImpl::ProcessOneEvent ( void  )
private

Definition at line 130 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(), 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
evthe event to remove from the list of scheduled events.

Implements ns3::SimulatorImpl.

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

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

+ 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::Stop with stop time 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 184 of file default-simulator-impl.cc.

References m_events, m_main, m_stop, m_unscheduledEvents, NS_ASSERT, NS_LOG_FUNCTION, 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
timedelay until the event expires
eventthe 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 220 of file default-simulator-impl.cc.

References ns3::SystemThread::Equals(), GetContext(), ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, 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, NS_LOG_FUNCTION, and ns3::TimeStep().

+ Here is the call graph for this function:

EventId ns3::DefaultSimulatorImpl::ScheduleDestroy ( EventImpl *  event)
virtual
Parameters
eventthe 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 288 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
eventthe 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 272 of file default-simulator-impl.cc.

References ns3::SystemThread::Equals(), GetContext(), ns3::Scheduler::Event::impl, 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
timedelay until the event expires
contextevent context
eventthe 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 241 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::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
schedulerFactorya 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 106 of file default-simulator-impl.cc.

References ns3::ObjectFactory::Create(), m_events, and NS_LOG_FUNCTION.

+ 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 203 of file default-simulator-impl.cc.

References m_stop, and NS_LOG_FUNCTION.

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
timethe stop time, relative to the current time.

Implements ns3::SimulatorImpl.

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

References ns3::Time::GetTimeStep(), NS_LOG_FUNCTION, ns3::Simulator::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 89 of file default-simulator-impl.h.

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

uint64_t ns3::DefaultSimulatorImpl::m_currentTs
private

Definition at line 88 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 87 of file default-simulator-impl.h.

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

DestroyEvents ns3::DefaultSimulatorImpl::m_destroyEvents
private

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

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

Ptr<Scheduler> ns3::DefaultSimulatorImpl::m_events
private

Definition at line 84 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 77 of file default-simulator-impl.h.

Referenced by ProcessEventsWithContext(), and ScheduleWithContext().

bool ns3::DefaultSimulatorImpl::m_eventsWithContextEmpty
private

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

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

SystemMutex ns3::DefaultSimulatorImpl::m_eventsWithContextMutex
private

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

Referenced by ProcessEventsWithContext(), and ScheduleWithContext().

SystemThread::ThreadId ns3::DefaultSimulatorImpl::m_main
private

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

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

bool ns3::DefaultSimulatorImpl::m_stop
private

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

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

uint32_t ns3::DefaultSimulatorImpl::m_uid
private

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

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

int ns3::DefaultSimulatorImpl::m_unscheduledEvents
private

Definition at line 92 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: