ns-3
|
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. |
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).
ev | the event to cancel |
Implements ns3::SimulatorImpl.
References IsExpired().
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.
References ns3::EventImpl::Invoke(), ns3::EventImpl::IsCancelled(), NS_LOG_FUNCTION_NOARGS, and NS_LOG_LOGIC.
uint32_t ns3::RealtimeSimulatorImpl::GetContext | ( | void | ) | const [virtual] |
Implements ns3::SimulatorImpl.
Referenced by Schedule(), and ScheduleNow().
Time ns3::RealtimeSimulatorImpl::GetDelayLeft | ( | const EventId & | id | ) | const [virtual] |
id | the event id to analyse |
Implements ns3::SimulatorImpl.
References IsExpired().
Time ns3::RealtimeSimulatorImpl::GetMaximumSimulationTime | ( | void | ) | const [virtual] |
The returned value will always be bigger than or equal to Simulator::Now.
Implements ns3::SimulatorImpl.
uint32_t ns3::RealtimeSimulatorImpl::GetSystemId | ( | void | ) | const [virtual] |
Implements ns3::SimulatorImpl.
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:
Attributes defined for this type:
No TraceSources defined for this type.
Reimplemented from ns3::SimulatorImpl.
References ns3::Seconds(), ns3::TypeId::SetParent(), and SYNC_HARD_LIMIT.
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.
ev | the event to test for expiration |
Implements ns3::SimulatorImpl.
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.
References ns3::Scheduler::IsEmpty(), and NS_LOG_FUNCTION_NOARGS.
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.
References NS_LOG_FUNCTION_NOARGS.
Time ns3::RealtimeSimulatorImpl::Now | ( | void | ) | const [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).
ev | the event to remove from the list of scheduled events. |
Implements ns3::SimulatorImpl.
References IsExpired(), and ns3::Scheduler::Remove().
void ns3::RealtimeSimulatorImpl::Run | ( | void | ) | [virtual] |
Run the simulation until one of:
Implements ns3::SimulatorImpl.
References ns3::Scheduler::IsEmpty(), NS_ASSERT_MSG, NS_LOG_FUNCTION_NOARGS, and ns3::Synchronizer::SetOrigin().
void ns3::RealtimeSimulatorImpl::RunOneEvent | ( | void | ) | [virtual] |
Process only the next simulation event, then return immediately.
Implements ns3::SimulatorImpl.
References ns3::EventImpl::Invoke(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, and ns3::Scheduler::RemoveNext().
EventId ns3::RealtimeSimulatorImpl::Schedule | ( | Time const & | time, |
EventImpl * | event | ||
) | [virtual] |
time | delay until the event expires |
event | the event to schedule |
This method will be typically used by language bindings to delegate events to their own subclass of the EventImpl base class.
Implements ns3::SimulatorImpl.
References GetContext(), ns3::Time::GetTimeStep(), ns3::Scheduler::Insert(), ns3::Time::IsPositive(), Now(), NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::Synchronizer::Signal().
Referenced by Stop().
EventId ns3::RealtimeSimulatorImpl::ScheduleDestroy | ( | EventImpl * | event | ) | [virtual] |
event | the event to schedule |
This method will be typically used by language bindings to delegate events to their own subclass of the EventImpl base class.
Implements ns3::SimulatorImpl.
References NS_LOG_FUNCTION_NOARGS.
EventId ns3::RealtimeSimulatorImpl::ScheduleNow | ( | EventImpl * | event | ) | [virtual] |
event | the event to schedule |
This method will be typically used by language bindings to delegate events to their own subclass of the EventImpl base class.
Implements ns3::SimulatorImpl.
References GetContext(), ns3::Scheduler::Insert(), NS_LOG_FUNCTION_NOARGS, and ns3::Synchronizer::Signal().
void ns3::RealtimeSimulatorImpl::ScheduleWithContext | ( | uint32_t | context, |
Time const & | time, | ||
EventImpl * | event | ||
) | [virtual] |
time | delay until the event expires |
context | event context |
event | the event to schedule |
This method will be typically used by language bindings to delegate events to their own subclass of the EventImpl base class.
Implements ns3::SimulatorImpl.
References ns3::Time::GetTimeStep(), ns3::Scheduler::Insert(), NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::Synchronizer::Signal().
void ns3::RealtimeSimulatorImpl::SetScheduler | ( | ObjectFactory | schedulerFactory | ) | [virtual] |
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.
References ns3::ObjectFactory::Create(), ns3::Scheduler::Insert(), ns3::Scheduler::IsEmpty(), NS_LOG_FUNCTION_NOARGS, and ns3::Scheduler::RemoveNext().
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.
References NS_LOG_FUNCTION_NOARGS.
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.
time | the stop time, relative to the current time. |
Implements ns3::SimulatorImpl.
References Schedule(), and ns3::Simulator::Stop().