#include "simulator-impl.h"

Inheritance diagram for ns3::SimulatorImpl:

Collaboration diagram for ns3::SimulatorImpl:

Public Member Functions
virtual void	Cancel (const EventId &id)=0
	Set the cancel bit on this event: the event's associated function will not be invoked when it expires.

virtual void	Destroy ()=0
	Execute the events scheduled with ScheduleDestroy().

virtual uint32_t	GetContext () const =0
	Get the current simulation context.

virtual Time	GetDelayLeft (const EventId &id) const =0
	Get the remaining time until this event will execute.

virtual uint64_t	GetEventCount () const =0
	Get the number of events executed.

virtual Time	GetMaximumSimulationTime () const =0
	Get the maximum representable simulation time.

virtual uint32_t	GetSystemId () const =0
	Get the system id of this simulator.

virtual bool	IsExpired (const EventId &id) const =0
	Check if an event has already run or been cancelled.

virtual bool	IsFinished () const =0
	Check if the simulation should finish.

virtual Time	Now () const =0
	Return the current simulation virtual time.

virtual void	PreEventHook (const EventId &id)
	Hook called before processing each event.

virtual void	Remove (const EventId &id)=0
	Remove an event from the event list.

virtual void	Run ()=0
	Run the simulation.

virtual EventId	Schedule (const Time &delay, EventImpl *event)=0
	Schedule a future event execution (in the same context).

virtual EventId	ScheduleDestroy (EventImpl *event)=0
	Schedule an event to run at the end of the simulation, after the Stop() time or condition has been reached.

virtual EventId	ScheduleNow (EventImpl *event)=0
	Schedule an event to run at the current virtual time.

virtual void	ScheduleWithContext (uint32_t context, const Time &delay, EventImpl *event)=0
	Schedule a future event execution (in a different context).

virtual void	SetScheduler (ObjectFactory schedulerFactory)=0
	Set the Scheduler to be used to manage the event list.

virtual void	Stop ()=0
	Tell the Simulator the calling event should be the last one executed.

virtual EventId	Stop (const Time &delay)=0
	Schedule the time delay until the Simulator should stop.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the registered TypeId for this class.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

The SimulatorImpl base class.

Todo: Define what the simulation or event context means.

Definition at line 37 of file simulator-impl.h.

Member Function Documentation

◆ Cancel()

virtual void ns3::SimulatorImpl::Cancel ( const EventId & id )

pure 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

[in] id the event to cancel

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::Cancel().

Here is the caller graph for this function:

◆ Destroy()

virtual void ns3::SimulatorImpl::Destroy ( )

pure virtual

Execute the events scheduled with ScheduleDestroy().

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.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::VisualSimulatorImpl::Destroy().

Here is the caller graph for this function:

◆ GetContext()

virtual uint32_t ns3::SimulatorImpl::GetContext ( ) const

pure virtual

Get the current simulation context.

The simulation context is the ns-3 notion of a Logical Process. Events in a single context should only modify state associated with that context. Events for objects in other contexts should be scheduled with ScheduleWithContext() to track the context switches. In other words, events in different contexts should be mutually thread safe, by not modify overlapping model state.

In circumstances where the context can't be determined, such as during object initialization, the enum value NO_CONTEXT should be used.

Returns: The current simulation context

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::GetContext().

Here is the caller graph for this function:

◆ GetDelayLeft()

virtual Time ns3::SimulatorImpl::GetDelayLeft ( const EventId & id ) const

pure virtual

Get the remaining time until this event will execute.

Parameters

[in] 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.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::GetDelayLeft().

Here is the caller graph for this function:

◆ GetEventCount()

virtual uint64_t ns3::SimulatorImpl::GetEventCount ( ) const

pure virtual

Get the number of events executed.

Returns: The total number of events executed.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::GetEventCount().

Here is the caller graph for this function:

◆ GetMaximumSimulationTime()

virtual Time ns3::SimulatorImpl::GetMaximumSimulationTime ( ) const

pure virtual

Get the maximum representable simulation time.

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.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::GetMaximumSimulationTime().

Here is the caller graph for this function:

◆ GetSystemId()

virtual uint32_t ns3::SimulatorImpl::GetSystemId ( ) const

pure virtual

Get the system id of this simulator.

The system id is the identifier for this simulator instance in a distributed simulation. For MPI this is the MPI rank.

Returns: The system id for this simulator.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::GetSystemId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SimulatorImpl::GetTypeId ( )

static

Get the registered TypeId for this class.

Returns: The object TypeId.

Definition at line 26 of file simulator-impl.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ IsExpired()

virtual bool ns3::SimulatorImpl::IsExpired ( const EventId & id ) const

pure virtual

Check if an event has already run or been cancelled.

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 executed, which means that if the code executed by the event calls this function, it will get true.

Parameters

[in] id The event to test for expiration.

Returns: true if the event has expired, false otherwise.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::IsExpired().

Here is the caller graph for this function:

◆ IsFinished()

virtual bool ns3::SimulatorImpl::IsFinished ( ) const

pure virtual

Check if the simulation should finish.

Reasons to finish are because there are no more events lefts to be scheduled, or if simulation time has already reached the "stop time" (see Simulator::Stop()).

Returns: true if no more events or stop time reached.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::IsFinished().

Here is the caller graph for this function:

◆ Now()

virtual Time ns3::SimulatorImpl::Now ( ) const

pure virtual

Return the current simulation virtual time.

Returns: The current virtual time.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::Now().

Here is the caller graph for this function:

◆ PreEventHook()

virtual void ns3::SimulatorImpl::PreEventHook ( const EventId & id )

inlinevirtual

Hook called before processing each event.

Parameters

[in] id The event about to be processed.

Definition at line 98 of file simulator-impl.h.

Referenced by ns3::DefaultSimulatorImpl::ProcessOneEvent(), ns3::DistributedSimulatorImpl::ProcessOneEvent(), ns3::NullMessageSimulatorImpl::ProcessOneEvent(), and ns3::RealtimeSimulatorImpl::ProcessOneEvent().

Here is the caller graph for this function:

◆ Remove()

virtual void ns3::SimulatorImpl::Remove ( const EventId & id )

pure 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

[in] id The event to remove from the list of scheduled events.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::Remove().

Here is the caller graph for this function:

◆ Run()

virtual void ns3::SimulatorImpl::Run ( )

pure virtual

Run the simulation.

The simulation will run until one of:

No events are present anymore
The user called Simulator::Stop
The user called Simulator::Stop with a stop time and the expiration time of the next event to be processed is greater than or equal to the stop time.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::Run().

Here is the caller graph for this function:

◆ Schedule()

virtual EventId ns3::SimulatorImpl::Schedule	(	const Time &	delay,
		EventImpl *	event )

pure virtual

Schedule a future event execution (in the same context).

Parameters

[in]	delay	Delay until the event expires.
[in]	event	The event to schedule.

Returns: A unique identifier for the newly-scheduled event.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::DoSchedule().

Here is the caller graph for this function:

◆ ScheduleDestroy()

virtual EventId ns3::SimulatorImpl::ScheduleDestroy ( EventImpl * event )

pure virtual

Schedule an event to run at the end of the simulation, after the Stop() time or condition has been reached.

Parameters

[in] event The event to schedule.

Returns: A unique identifier for the newly-scheduled event.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::DoScheduleDestroy().

Here is the caller graph for this function:

◆ ScheduleNow()

virtual EventId ns3::SimulatorImpl::ScheduleNow ( EventImpl * event )

pure virtual

Schedule an event to run at the current virtual time.

Parameters

[in] event The event to schedule.

Returns: A unique identifier for the newly-scheduled event.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::DoScheduleNow().

Here is the caller graph for this function:

◆ ScheduleWithContext()

virtual void ns3::SimulatorImpl::ScheduleWithContext	(	uint32_t	context,
		const Time &	delay,
		EventImpl *	event )

pure virtual

Schedule a future event execution (in a different context).

This method is thread-safe: it can be called from any thread.

Parameters

[in]	delay	Delay until the event expires.
[in]	context	Event context.
[in]	event	The event to schedule.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::ScheduleWithContext().

Here is the caller graph for this function:

◆ SetScheduler()

virtual void ns3::SimulatorImpl::SetScheduler ( ObjectFactory schedulerFactory )

pure virtual

Set the Scheduler to be used to manage the event list.

Parameters

[in] schedulerFactory A new event scheduler factory.

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

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::SetScheduler().

Here is the caller graph for this function:

◆ Stop() [1/2]

virtual void ns3::SimulatorImpl::Stop ( )

pure virtual

Tell the Simulator the calling event should be the last one executed.

If a running event invokes this method, it will be the last event executed by the Simulator::Run method before returning to the caller.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

Referenced by ns3::Simulator::Stop(), and ns3::Simulator::Stop().

Here is the caller graph for this function:

◆ Stop() [2/2]

virtual EventId ns3::SimulatorImpl::Stop ( const Time & delay )

pure virtual

Schedule the time delay until the Simulator should stop.

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

[in] delay The stop time, relative to the current time.

Returns: The stop EventId.

Implemented in ns3::DefaultSimulatorImpl, ns3::DistributedSimulatorImpl, ns3::NullMessageSimulatorImpl, ns3::RealtimeSimulatorImpl, and ns3::VisualSimulatorImpl.

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

src/core/model/simulator-impl.h
src/core/model/simulator-impl.cc

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Cancel()

◆ Destroy()

◆ GetContext()

◆ GetDelayLeft()

◆ GetEventCount()

◆ GetMaximumSimulationTime()

◆ GetSystemId()

◆ GetTypeId()

◆ IsExpired()

◆ IsFinished()

◆ Now()

◆ PreEventHook()

◆ Remove()

◆ Run()

◆ Schedule()

◆ ScheduleDestroy()

◆ ScheduleNow()

◆ ScheduleWithContext()

◆ SetScheduler()

◆ Stop() [1/2]

◆ Stop() [2/2]