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

#include <realtime-simulator-impl.h>

Inheritance diagram for ns3::RealtimeSimulatorImpl:

Collaboration diagram for ns3::RealtimeSimulatorImpl:

Public Types
enum	SynchronizationMode { SYNC_BEST_EFFORT, SYNC_HARD_LIMIT }
	Enumeration of the types of packets supported in the class. More...

Public Member Functions
	RealtimeSimulatorImpl ()

	~RealtimeSimulatorImpl ()

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

Time	GetHardLimit (void) const

virtual Time	GetMaximumSimulationTime (void) const

RealtimeSimulatorImpl::SynchronizationMode	GetSynchronizationMode (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...

Time	RealtimeNow (void) const

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)

void	ScheduleRealtime (Time const &time, EventImpl *event)

void	ScheduleRealtimeNow (EventImpl *event)

void	ScheduleRealtimeNowWithContext (uint32_t context, EventImpl *event)

void	ScheduleRealtimeWithContext (uint32_t context, Time const &time, EventImpl *event)

virtual void	ScheduleWithContext (uint32_t context, Time const &time, EventImpl *event)

void	SetHardLimit (Time limit)

virtual void	SetScheduler (ObjectFactory schedulerFactory)

void	SetSynchronizationMode (RealtimeSimulatorImpl::SynchronizationMode mode)

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

Private Member Functions
virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

uint64_t	NextTs (void) const

void	ProcessOneEvent (void)

bool	Realtime (void) const

bool	Running (void) const

Private Attributes
uint32_t	m_currentContext

uint64_t	m_currentTs

uint32_t	m_currentUid

DestroyEvents	m_destroyEvents

Ptr< Scheduler >	m_events

Time	m_hardLimit
	The maximum allowable drift from real-time in SYNC_HARD_LIMIT mode. More...

SystemThread::ThreadId	m_main

SystemMutex	m_mutex

bool	m_running

bool	m_stop

SynchronizationMode	m_synchronizationMode
	The policy to use if the simulation cannot keep synchronized to real-time. More...

Ptr< Synchronizer >	m_synchronizer

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.

Attributes

SynchronizationMode: What to do if the simulation cannot keep up with real time.
- Set with class: ns3::EnumValue
- Underlying type:
- Initial value: BestEffort
- Flags: construct write
HardLimit: Maximum acceptable real-time jitter (used in conjunction with SynchronizationMode=HardLimit)
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +100000000.0ns
- Flags: construct write read

No TraceSources are defined for this type.

Definition at line 41 of file realtime-simulator-impl.h.

Member Typedef Documentation

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

private

Definition at line 96 of file realtime-simulator-impl.h.

Member Enumeration Documentation

enum ns3::RealtimeSimulatorImpl::SynchronizationMode

Enumeration of the types of packets supported in the class.

Enumerator
SYNC_BEST_EFFORT
SYNC_HARD_LIMIT	Make a best effort to keep synced to real-time.

Definition at line 50 of file realtime-simulator-impl.h.

Constructor & Destructor Documentation

ns3::RealtimeSimulatorImpl::RealtimeSimulatorImpl ( )

Definition at line 70 of file realtime-simulator-impl.cc.

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

Here is the call graph for this function:

ns3::RealtimeSimulatorImpl::~RealtimeSimulatorImpl ( )

Definition at line 94 of file realtime-simulator-impl.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::RealtimeSimulatorImpl::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 744 of file realtime-simulator-impl.cc.

References IsExpired().

Here is the call graph for this function:

void ns3::RealtimeSimulatorImpl::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 114 of file realtime-simulator-impl.cc.

References m_destroyEvents, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

void ns3::RealtimeSimulatorImpl::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 100 of file realtime-simulator-impl.cc.

References ns3::Object::DoDispose(), ns3::Scheduler::Event::impl, m_events, m_synchronizer, NS_LOG_FUNCTION, and ns3::SimpleRefCount< T, PARENT, DELETER >::Unref().

Here is the call graph for this function:

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

virtual

Returns: the current simulation context

Implements ns3::SimulatorImpl.

Definition at line 811 of file realtime-simulator-impl.cc.

References m_currentContext.

Referenced by Schedule(), ScheduleNow(), ScheduleRealtime(), and ScheduleRealtimeNow().

Here is the caller graph for this function:

Time ns3::RealtimeSimulatorImpl::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 690 of file realtime-simulator-impl.cc.

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

Here is the call graph for this function:

Time ns3::RealtimeSimulatorImpl::GetHardLimit ( void ) const

Definition at line 838 of file realtime-simulator-impl.cc.

References m_hardLimit, and NS_LOG_FUNCTION.

Time ns3::RealtimeSimulatorImpl::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 796 of file realtime-simulator-impl.cc.

References ns3::TimeStep().

Here is the call graph for this function:

RealtimeSimulatorImpl::SynchronizationMode ns3::RealtimeSimulatorImpl::GetSynchronizationMode ( void ) const

Definition at line 824 of file realtime-simulator-impl.cc.

References m_synchronizationMode, and NS_LOG_FUNCTION.

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

virtual

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

Implements ns3::SimulatorImpl.

Definition at line 805 of file realtime-simulator-impl.cc.

TypeId ns3::RealtimeSimulatorImpl::GetTypeId ( void )

static

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

References m_hardLimit, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeTimeChecker(), ns3::TypeId::SetParent(), SetSynchronizationMode(), SYNC_BEST_EFFORT, and SYNC_HARD_LIMIT.

Here is the call graph for this function:

bool ns3::RealtimeSimulatorImpl::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 753 of file realtime-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::RealtimeSimulatorImpl::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 390 of file realtime-simulator-impl.cc.

References m_events, m_mutex, and m_stop.

uint64_t ns3::RealtimeSimulatorImpl::NextTs ( void ) const

private

Definition at line 405 of file realtime-simulator-impl.cc.

References m_events, and NS_ASSERT_MSG.

Referenced by ProcessOneEvent().

Here is the caller graph for this function:

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

virtual

Return the "current simulation time".

Implements ns3::SimulatorImpl.

Definition at line 592 of file realtime-simulator-impl.cc.

References m_currentTs, and ns3::TimeStep().

Here is the call graph for this function:

void ns3::RealtimeSimulatorImpl::ProcessOneEvent ( void )

private

Definition at line 161 of file realtime-simulator-impl.cc.

References ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, m_currentContext, m_currentTs, m_currentUid, m_events, m_hardLimit, m_mutex, m_synchronizationMode, m_synchronizer, m_unscheduledEvents, NextTs(), NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_LOGIC, and SYNC_HARD_LIMIT.

Referenced by Run().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::RealtimeSimulatorImpl::Realtime ( void ) const

private

Definition at line 482 of file realtime-simulator-impl.cc.

References m_synchronizer.

Time ns3::RealtimeSimulatorImpl::RealtimeNow ( void ) const

Definition at line 662 of file realtime-simulator-impl.cc.

References m_synchronizer, and ns3::TimeStep().

Here is the call graph for this function:

void ns3::RealtimeSimulatorImpl::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 705 of file realtime-simulator-impl.cc.

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

Here is the call graph for this function:

void ns3::RealtimeSimulatorImpl::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 414 of file realtime-simulator-impl.cc.

References m_currentTs, m_events, m_main, m_mutex, m_running, m_stop, m_synchronizer, m_unscheduledEvents, NS_ASSERT_MSG, NS_LOG_FUNCTION, ProcessOneEvent(), and ns3::SystemThread::Self().

Here is the call graph for this function:

bool ns3::RealtimeSimulatorImpl::Running ( void ) const

private

Definition at line 476 of file realtime-simulator-impl.cc.

References m_running.

EventId ns3::RealtimeSimulatorImpl::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 505 of file realtime-simulator-impl.cc.

References 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_mutex, m_synchronizer, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_uid, m_unscheduledEvents, ns3::Simulator::Now(), NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::TimeStep().

Here is the call graph for this function:

EventId ns3::RealtimeSimulatorImpl::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 668 of file realtime-simulator-impl.cc.

References m_currentTs, m_destroyEvents, m_mutex, m_uid, and NS_LOG_FUNCTION.

EventId ns3::RealtimeSimulatorImpl::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 571 of file realtime-simulator-impl.cc.

References GetContext(), ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, m_mutex, m_synchronizer, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_uid, m_unscheduledEvents, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::RealtimeSimulatorImpl::ScheduleRealtime	(	Time const &	time,
		EventImpl *	event
	)

Definition at line 622 of file realtime-simulator-impl.cc.

References GetContext(), NS_LOG_FUNCTION, and ScheduleRealtimeWithContext().

Here is the call graph for this function:

void ns3::RealtimeSimulatorImpl::ScheduleRealtimeNow ( EventImpl * event )

Definition at line 655 of file realtime-simulator-impl.cc.

References GetContext(), NS_LOG_FUNCTION, and ScheduleRealtimeNowWithContext().

Here is the call graph for this function:

void ns3::RealtimeSimulatorImpl::ScheduleRealtimeNowWithContext	(	uint32_t	context,
		EventImpl *	event
	)

Definition at line 629 of file realtime-simulator-impl.cc.

References ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, m_mutex, m_running, m_synchronizer, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_uid, m_unscheduledEvents, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by ScheduleRealtimeNow().

Here is the caller graph for this function:

void ns3::RealtimeSimulatorImpl::ScheduleRealtimeWithContext	(	uint32_t	context,
		Time const &	time,
		EventImpl *	event
	)

Definition at line 601 of file realtime-simulator-impl.cc.

References ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, m_currentTs, m_events, m_mutex, m_synchronizer, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_uid, m_unscheduledEvents, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by ScheduleRealtime().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::RealtimeSimulatorImpl::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 535 of file realtime-simulator-impl.cc.

References ns3::SystemThread::Equals(), ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, m_main, m_mutex, m_running, m_synchronizer, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_uid, m_unscheduledEvents, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::RealtimeSimulatorImpl::SetHardLimit ( Time limit )

Definition at line 831 of file realtime-simulator-impl.cc.

References m_hardLimit, and NS_LOG_FUNCTION.

void ns3::RealtimeSimulatorImpl::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 139 of file realtime-simulator-impl.cc.

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

Here is the call graph for this function:

void ns3::RealtimeSimulatorImpl::SetSynchronizationMode ( RealtimeSimulatorImpl::SynchronizationMode mode )

Definition at line 817 of file realtime-simulator-impl.cc.

References m_synchronizationMode, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

void ns3::RealtimeSimulatorImpl::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 488 of file realtime-simulator-impl.cc.

References m_stop, and NS_LOG_FUNCTION.

void ns3::RealtimeSimulatorImpl::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