ns3::RealtimeSimulatorImpl Class Reference

Inheritance diagram for ns3::RealtimeSimulatorImpl:
Inheritance graph
[legend]
Collaboration diagram for ns3::RealtimeSimulatorImpl:
Collaboration graph
[legend]

List of all members.

Public Types

enum  SynchronizationMode { SYNC_BEST_EFFORT, SYNC_HARD_LIMIT }

Public Member Functions

virtual void Destroy ()
virtual bool IsFinished (void) const
virtual Time Next (void) const
virtual void Stop (void)
virtual void Stop (Time const &time)
virtual EventId Schedule (Time const &time, EventImpl *event)
virtual void ScheduleWithContext (uint32_t context, Time const &time, EventImpl *event)
virtual EventId ScheduleNow (EventImpl *event)
virtual EventId ScheduleDestroy (EventImpl *event)
virtual void Remove (const EventId &ev)
virtual void Cancel (const EventId &ev)
virtual bool IsExpired (const EventId &ev) const
virtual void Run (void)
virtual void RunOneEvent (void)
virtual Time Now (void) const
virtual Time GetDelayLeft (const EventId &id) const
virtual Time GetMaximumSimulationTime (void) const
virtual void SetScheduler (ObjectFactory schedulerFactory)
virtual uint32_t GetSystemId (void) const
virtual uint32_t GetContext (void) const
void ScheduleRealtimeWithContext (uint32_t context, Time const &time, EventImpl *event)
void ScheduleRealtime (Time const &time, EventImpl *event)
void ScheduleRealtimeNowWithContext (uint32_t context, EventImpl *event)
void ScheduleRealtimeNow (EventImpl *event)
Time RealtimeNow (void) const
void SetSynchronizationMode (RealtimeSimulatorImpl::SynchronizationMode mode)
RealtimeSimulatorImpl::SynchronizationMode GetSynchronizationMode (void) const
void SetHardLimit (Time limit)
Time GetHardLimit (void) const

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::RealtimeSimulatorImpl.

Member Enumeration Documentation

enum ns3::RealtimeSimulatorImpl::SynchronizationMode

Enumeration of the types of packets supported in the class.

Enumerator:
SYNC_HARD_LIMIT 

Make a best effort to keep synced to real-time

Member Function Documentation

virtual 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.

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

virtual uint32_t ns3::RealtimeSimulatorImpl::GetContext ( void   )  const [virtual]
Returns:
the current simulation context

Implements ns3::SimulatorImpl.

virtual 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.

virtual 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.

virtual 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.

static TypeId ns3::RealtimeSimulatorImpl::GetTypeId ( void   )  [static]

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

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::RealtimeSimulatorImpl
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::SimulatorImpl/$ns3::RealtimeSimulatorImpl

Attributes defined for this type:

  • 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: 100000000ns
    • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::SimulatorImpl.

virtual 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.

virtual 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.

virtual Time ns3::RealtimeSimulatorImpl::Next ( void   )  const [virtual]

If Simulator::IsFinished returns true, the behavior of this method is undefined. Otherwise, it returns the microsecond-based time of the next event expected to be scheduled.

Implements ns3::SimulatorImpl.

virtual Time ns3::RealtimeSimulatorImpl::Now ( void   )  const [virtual]

Return the "current simulation time".

Implements ns3::SimulatorImpl.

virtual 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.

virtual 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::stopAtUs and the expiration time of the next event to be processed is greater than or equal to the stop time.

Implements ns3::SimulatorImpl.

virtual void ns3::RealtimeSimulatorImpl::RunOneEvent ( void   )  [virtual]

Process only the next simulation event, then return immediately.

Implements ns3::SimulatorImpl.

virtual 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.

virtual 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.

virtual 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.

virtual 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.

virtual 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.

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

Implements ns3::SimulatorImpl.

virtual 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.

The documentation for this class was generated from the following files:
Generated on 6 Jan 2011 for NS-3 by  doxygen 1.6.1