A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::RealtimeSimulatorImpl Class Reference

#include <introspected-doxygen.h>

+ Inheritance diagram for ns3::RealtimeSimulatorImpl:

Public Types

enum  SynchronizationMode { SYNC_BEST_EFFORT, SYNC_HARD_LIMIT }
 

Public Member Functions

virtual void Cancel (const EventId &ev)
 
virtual void Destroy ()
 
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
 
virtual bool IsFinished (void) const
 
virtual Time Now (void) const
 
Time RealtimeNow (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)
 
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)
 
virtual void Stop (Time const &time)
 
- Public Member Functions inherited from ns3::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 Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::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)
 
- Static Public Member Functions inherited from ns3::SimulatorImpl
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Types

typedef std::list< EventIdDestroyEvents
 

Private Member Functions

virtual void DoDispose (void)
 
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< Schedulerm_events
 
Time m_hardLimit
 
SystemThread::ThreadId m_main
 
SystemMutex m_mutex
 
bool m_running
 
bool m_stop
 
SynchronizationMode m_synchronizationMode
 
Ptr< Synchronizerm_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)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

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: BestEffort|HardLimit
    • Initial value: BestEffort
    • Flags: construct write
  • HardLimit: Maximum acceptable real-time jitter (used in conjunction with SynchronizationMode=HardLimit)
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +100000000.0ns
    • Flags: construct write read

No TraceSources are defined for this type.

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

Member Enumeration Documentation

Enumeration of the types of packets supported in the class.

Enumerator
SYNC_HARD_LIMIT 

Make a best effort to keep synced to real-time

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

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

Implements ns3::SimulatorImpl.

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

References IsExpired().

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 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(), NS_LOG_FUNCTION, and ns3::SimpleRefCount< T, PARENT, DELETER >::Unref().

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.

Referenced by Schedule(), and ScheduleNow().

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

References IsExpired().

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.

Implements ns3::SimulatorImpl.

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

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.

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
evthe 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::EventImpl::IsCancelled().

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

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.

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.

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
evthe event to remove from the list of scheduled events.

Implements ns3::SimulatorImpl.

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

References IsExpired().

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 NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::SystemThread::Self().

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

References GetContext(), ns3::Time::GetTimeStep(), ns3::Time::IsPositive(), ns3::Simulator::Now(), NS_ASSERT_MSG, and NS_LOG_FUNCTION.

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

References NS_LOG_FUNCTION.

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

References GetContext(), and NS_LOG_FUNCTION.

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

References ns3::SystemThread::Equals(), ns3::Time::GetTimeStep(), NS_ASSERT_MSG, and NS_LOG_FUNCTION.

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

References ns3::ObjectFactory::Create(), and NS_LOG_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 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
timethe stop time, relative to the current time.

Implements ns3::SimulatorImpl.

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

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

Member Data Documentation

Time ns3::RealtimeSimulatorImpl::m_hardLimit
private

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

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

SynchronizationMode ns3::RealtimeSimulatorImpl::m_synchronizationMode
private

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

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


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