Introspection did not find any typical Config paths. More...
#include <realtime-simulator-impl.h>
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 &id) |
Set the cancel bit on this event: the event's associated function will not be invoked when it expires. More... | |
virtual void | Destroy () |
Execute the events scheduled with ScheduleDestroy(). More... | |
virtual uint32_t | GetContext (void) const |
Get the current simulation context. More... | |
virtual Time | GetDelayLeft (const EventId &id) const |
Get the remaining time until this event will execute. More... | |
Time | GetHardLimit (void) const |
virtual Time | GetMaximumSimulationTime (void) const |
Get the maximum representable simulation time. More... | |
RealtimeSimulatorImpl::SynchronizationMode | GetSynchronizationMode (void) const |
virtual uint32_t | GetSystemId (void) const |
Get the system id of this simulator. More... | |
virtual bool | IsExpired (const EventId &id) const |
Check if an event has already run or been cancelled. More... | |
virtual bool | IsFinished (void) const |
Check if the simulation should finish. More... | |
virtual Time | Now (void) const |
Return the current simulation virtual time. More... | |
Time | RealtimeNow (void) const |
virtual void | Remove (const EventId &id) |
Remove an event from the event list. More... | |
virtual void | Run (void) |
Run the simulation. More... | |
virtual EventId | Schedule (Time const &time, EventImpl *event) |
Schedule a future event execution (in the same context). More... | |
virtual EventId | ScheduleDestroy (EventImpl *event) |
Schedule an event to run at the end of the simulation, after the Stop() time or condition has been reached. More... | |
virtual EventId | ScheduleNow (EventImpl *event) |
Schedule an event to run at the current virtual time. More... | |
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) |
Schedule a future event execution (in a different context). More... | |
void | SetHardLimit (Time limit) |
virtual void | SetScheduler (ObjectFactory schedulerFactory) |
Set the Scheduler to be used to manage the event list. More... | |
void | SetSynchronizationMode (RealtimeSimulatorImpl::SynchronizationMode mode) |
virtual void | Stop (void) |
Tell the Simulator the calling event should be the last one executed. More... | |
virtual void | Stop (Time const &time) |
Schedule the time delay until the Simulator should stop. More... | |
![]() | |
Object () | |
Constructor. More... | |
virtual | ~Object () |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose (void) |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator (void) const |
Get an iterator to the Objects aggregated to this one. More... | |
virtual TypeId | GetInstanceTypeId (void) const |
Implement the GetInstanceTypeId method defined in ObjectBase. More... | |
template<typename T > | |
Ptr< T > | GetObject (void) const |
Get a pointer to the requested aggregated Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object. More... | |
void | Initialize (void) |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
![]() | |
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... | |
![]() | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising erros. More... | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. More... | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. More... | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. More... | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. More... | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. More... | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
![]() | |
static TypeId | GetTypeId (void) |
Get the registered TypeId for this class. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
![]() | |
static void | Cleanup (void) |
Noop. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Types | |
typedef std::list< EventId > | DestroyEvents |
Private Member Functions | |
virtual void | DoDispose (void) |
Destructor implementation. 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 | |
![]() | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | DoInitialize (void) |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate (void) |
Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. More... | |
virtual void | NotifyConstructionCompleted (void) |
Notifier called once the ObjectBase is fully constructed. More... | |
![]() | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Introspection did not find any typical Config paths.
No TraceSources are defined for this type.
Size of this type is 136 bytes (on a 64-bit architecture).
Definition at line 41 of file realtime-simulator-impl.h.
|
private |
Definition at line 96 of file realtime-simulator-impl.h.
ns3::RealtimeSimulatorImpl::RealtimeSimulatorImpl | ( | ) |
Definition at line 76 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().
ns3::RealtimeSimulatorImpl::~RealtimeSimulatorImpl | ( | ) |
Definition at line 100 of file realtime-simulator-impl.cc.
References NS_LOG_FUNCTION.
|
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).
id | the event to cancel |
Implements ns3::SimulatorImpl.
Definition at line 750 of file realtime-simulator-impl.cc.
References IsExpired().
|
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.
Implements ns3::SimulatorImpl.
Definition at line 120 of file realtime-simulator-impl.cc.
References m_destroyEvents, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
|
privatevirtual |
Destructor implementation.
This method is called by 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 106 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().
|
virtual |
Get the current simulation context.
Implements ns3::SimulatorImpl.
Definition at line 817 of file realtime-simulator-impl.cc.
References m_currentContext.
Referenced by Schedule(), ScheduleNow(), ScheduleRealtime(), and ScheduleRealtimeNow().
Get the remaining time until this event will execute.
id | The event id to analyse. |
Implements ns3::SimulatorImpl.
Definition at line 696 of file realtime-simulator-impl.cc.
References IsExpired(), m_currentTs, and ns3::TimeStep().
Time ns3::RealtimeSimulatorImpl::GetHardLimit | ( | void | ) | const |
Definition at line 844 of file realtime-simulator-impl.cc.
References m_hardLimit, and NS_LOG_FUNCTION.
|
virtual |
Get the maximum representable simulation time.
The returned value will always be bigger than or equal to Simulator::Now.
Implements ns3::SimulatorImpl.
Definition at line 802 of file realtime-simulator-impl.cc.
References ns3::TimeStep().
RealtimeSimulatorImpl::SynchronizationMode ns3::RealtimeSimulatorImpl::GetSynchronizationMode | ( | void | ) | const |
Definition at line 830 of file realtime-simulator-impl.cc.
References m_synchronizationMode, and NS_LOG_FUNCTION.
|
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.
Implements ns3::SimulatorImpl.
Definition at line 811 of file realtime-simulator-impl.cc.
|
static |
Definition at line 55 of file realtime-simulator-impl.cc.
References m_hardLimit, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), ns3::TypeId::SetParent(), SetSynchronizationMode(), SYNC_BEST_EFFORT, and SYNC_HARD_LIMIT.
|
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 scheduled which means that if the code executed by the event calls this function, it will get true.
id | The event to test for expiration. |
true
if the event has expired, false otherwise. Implements ns3::SimulatorImpl.
Definition at line 759 of file realtime-simulator-impl.cc.
References m_currentTs, m_currentUid, and m_destroyEvents.
Referenced by Cancel(), GetDelayLeft(), and Remove().
|
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()).
true
if no more events or stop time reached. Implements ns3::SimulatorImpl.
Definition at line 396 of file realtime-simulator-impl.cc.
|
private |
Definition at line 411 of file realtime-simulator-impl.cc.
References m_events, and NS_ASSERT_MSG.
Referenced by ProcessOneEvent().
|
virtual |
Return the current simulation virtual time.
Implements ns3::SimulatorImpl.
Definition at line 598 of file realtime-simulator-impl.cc.
References m_currentTs, and ns3::TimeStep().
|
private |
Definition at line 167 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().
|
private |
Definition at line 488 of file realtime-simulator-impl.cc.
References m_synchronizer.
Time ns3::RealtimeSimulatorImpl::RealtimeNow | ( | void | ) | const |
Definition at line 668 of file realtime-simulator-impl.cc.
References m_synchronizer, and ns3::TimeStep().
|
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).
id | The event to remove from the list of scheduled events. |
Implements ns3::SimulatorImpl.
Definition at line 711 of file realtime-simulator-impl.cc.
References ns3::Scheduler::Event::impl, IsExpired(), m_destroyEvents, m_events, m_mutex, and m_unscheduledEvents.
|
virtual |
Run the simulation.
The simulation will run until one of:
Implements ns3::SimulatorImpl.
Definition at line 420 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().
|
private |
Definition at line 482 of file realtime-simulator-impl.cc.
References m_running.
Schedule a future event execution (in the same context).
time | Delay until the event expires. |
event | The event to schedule. |
Implements ns3::SimulatorImpl.
Definition at line 511 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().
Schedule an event to run at the end of the simulation, after the Stop() time or condition has been reached.
event | The event to schedule. |
Implements ns3::SimulatorImpl.
Definition at line 674 of file realtime-simulator-impl.cc.
References m_currentTs, m_destroyEvents, m_mutex, m_uid, and NS_LOG_FUNCTION.
Schedule an event to run at the current virtual time.
event | The event to schedule. |
Implements ns3::SimulatorImpl.
Definition at line 577 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.
Definition at line 628 of file realtime-simulator-impl.cc.
References GetContext(), NS_LOG_FUNCTION, and ScheduleRealtimeWithContext().
void ns3::RealtimeSimulatorImpl::ScheduleRealtimeNow | ( | EventImpl * | event | ) |
Definition at line 661 of file realtime-simulator-impl.cc.
References GetContext(), NS_LOG_FUNCTION, and ScheduleRealtimeNowWithContext().
void ns3::RealtimeSimulatorImpl::ScheduleRealtimeNowWithContext | ( | uint32_t | context, |
EventImpl * | event | ||
) |
Definition at line 635 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().
void ns3::RealtimeSimulatorImpl::ScheduleRealtimeWithContext | ( | uint32_t | context, |
Time const & | time, | ||
EventImpl * | event | ||
) |
Definition at line 607 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().
|
virtual |
Schedule a future event execution (in a different context).
time | Delay until the event expires. |
context | Event context. |
event | The event to schedule. |
Implements ns3::SimulatorImpl.
Definition at line 541 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.
void ns3::RealtimeSimulatorImpl::SetHardLimit | ( | Time | limit | ) |
Definition at line 837 of file realtime-simulator-impl.cc.
References m_hardLimit, and NS_LOG_FUNCTION.
|
virtual |
Set the Scheduler to be used to manage the event list.
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 145 of file realtime-simulator-impl.cc.
References ns3::ObjectFactory::Create(), m_events, m_mutex, and NS_LOG_FUNCTION.
void ns3::RealtimeSimulatorImpl::SetSynchronizationMode | ( | RealtimeSimulatorImpl::SynchronizationMode | mode | ) |
Definition at line 823 of file realtime-simulator-impl.cc.
References m_synchronizationMode, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
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.
Implements ns3::SimulatorImpl.
Definition at line 494 of file realtime-simulator-impl.cc.
References m_stop, and NS_LOG_FUNCTION.
|
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.
time | The stop time, relative to the current time. |
Implements ns3::SimulatorImpl.
Definition at line 501 of file realtime-simulator-impl.cc.
References NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::Simulator::Stop().
|
private |
Definition at line 107 of file realtime-simulator-impl.h.
Referenced by GetContext(), ProcessOneEvent(), and RealtimeSimulatorImpl().
|
private |
Definition at line 106 of file realtime-simulator-impl.h.
Referenced by GetDelayLeft(), IsExpired(), Now(), ProcessOneEvent(), RealtimeSimulatorImpl(), Run(), Schedule(), ScheduleDestroy(), ScheduleNow(), ScheduleRealtimeNowWithContext(), ScheduleRealtimeWithContext(), and ScheduleWithContext().
|
private |
Definition at line 105 of file realtime-simulator-impl.h.
Referenced by IsExpired(), ProcessOneEvent(), and RealtimeSimulatorImpl().
|
private |
Definition at line 97 of file realtime-simulator-impl.h.
Referenced by Destroy(), IsExpired(), Remove(), and ScheduleDestroy().
Definition at line 102 of file realtime-simulator-impl.h.
Referenced by DoDispose(), IsFinished(), NextTs(), ProcessOneEvent(), Remove(), Run(), Schedule(), ScheduleNow(), ScheduleRealtimeNowWithContext(), ScheduleRealtimeWithContext(), ScheduleWithContext(), and SetScheduler().
|
private |
The maximum allowable drift from real-time in SYNC_HARD_LIMIT mode.
Definition at line 121 of file realtime-simulator-impl.h.
Referenced by GetHardLimit(), GetTypeId(), ProcessOneEvent(), and SetHardLimit().
|
private |
Definition at line 123 of file realtime-simulator-impl.h.
Referenced by RealtimeSimulatorImpl(), Run(), and ScheduleWithContext().
|
mutableprivate |
Definition at line 109 of file realtime-simulator-impl.h.
Referenced by IsFinished(), ProcessOneEvent(), Remove(), Run(), Schedule(), ScheduleDestroy(), ScheduleNow(), ScheduleRealtimeNowWithContext(), ScheduleRealtimeWithContext(), ScheduleWithContext(), and SetScheduler().
|
private |
Definition at line 99 of file realtime-simulator-impl.h.
Referenced by RealtimeSimulatorImpl(), Run(), Running(), ScheduleRealtimeNowWithContext(), and ScheduleWithContext().
|
private |
Definition at line 98 of file realtime-simulator-impl.h.
Referenced by IsFinished(), RealtimeSimulatorImpl(), Run(), and Stop().
|
private |
The policy to use if the simulation cannot keep synchronized to real-time.
Definition at line 116 of file realtime-simulator-impl.h.
Referenced by GetSynchronizationMode(), ProcessOneEvent(), and SetSynchronizationMode().
|
private |
Definition at line 111 of file realtime-simulator-impl.h.
Referenced by DoDispose(), ProcessOneEvent(), Realtime(), RealtimeNow(), RealtimeSimulatorImpl(), Run(), Schedule(), ScheduleNow(), ScheduleRealtimeNowWithContext(), ScheduleRealtimeWithContext(), and ScheduleWithContext().
|
private |
Definition at line 104 of file realtime-simulator-impl.h.
Referenced by RealtimeSimulatorImpl(), Schedule(), ScheduleDestroy(), ScheduleNow(), ScheduleRealtimeNowWithContext(), ScheduleRealtimeWithContext(), and ScheduleWithContext().
|
private |
Definition at line 103 of file realtime-simulator-impl.h.
Referenced by ProcessOneEvent(), RealtimeSimulatorImpl(), Remove(), Run(), Schedule(), ScheduleNow(), ScheduleRealtimeNowWithContext(), ScheduleRealtimeWithContext(), and ScheduleWithContext().