A Discrete-Event Network Simulator
API
ns3::VisualSimulatorImpl Class Reference

A replacement simulator that starts the visualizer. More...

#include "visual-simulator-impl.h"

+ Inheritance diagram for ns3::VisualSimulatorImpl:
+ Collaboration diagram for ns3::VisualSimulatorImpl:

Public Member Functions

 VisualSimulatorImpl ()
 
 ~VisualSimulatorImpl ()
 
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...
 
virtual uint64_t GetEventCount (void) const
 Get the number of events executed. More...
 
virtual Time GetMaximumSimulationTime (void) const
 Get the maximum representable simulation time. More...
 
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...
 
virtual void Remove (const EventId &id)
 Remove an event from the event list. More...
 
virtual void Run (void)
 Run the simulation. More...
 
void RunRealSimulator (void)
 calls Run() in the wrapped simulator More...
 
virtual EventId Schedule (Time const &delay, 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...
 
virtual void ScheduleWithContext (uint32_t context, Time const &delay, EventImpl *event)
 Schedule a future event execution (in a different context). More...
 
virtual void SetScheduler (ObjectFactory schedulerFactory)
 Set the Scheduler to be used to manage the event list. More...
 
virtual void Stop (Time const &delay)
 Schedule the time delay until the Simulator should stop. More...
 
virtual void Stop (void)
 Tell the Simulator the calling event should be the last one executed. More...
 
- Public Member Functions inherited from ns3::Object
 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
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. 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
 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)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::SimulatorImpl
static TypeId GetTypeId (void)
 Get the registered TypeId for this class. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

void DoDispose ()
 Destructor implementation. More...
 
void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 
- Protected Member Functions inherited from ns3::Object
 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...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 

Private Member Functions

Ptr< SimulatorImplGetSim ()
 get the simulator implementation More...
 

Private Attributes

Ptr< SimulatorImplm_simulator
 the simulator implementation More...
 
ObjectFactory m_simulatorImplFactory
 simulator implementation factory More...
 

Additional Inherited Members

Detailed Description

A replacement simulator that starts the visualizer.

To use this class, run any ns-3 simulation with the command-line argument –SimulatorImplementationType=ns3::VisualSimulatorImpl. This causes the visualizer (PyViz) to start automatically.

Definition at line 44 of file visual-simulator-impl.h.

Constructor & Destructor Documentation

◆ VisualSimulatorImpl()

ns3::VisualSimulatorImpl::VisualSimulatorImpl ( )

Definition at line 62 of file visual-simulator-impl.cc.

References ns3::PacketMetadata::Enable().

+ Here is the call graph for this function:

◆ ~VisualSimulatorImpl()

ns3::VisualSimulatorImpl::~VisualSimulatorImpl ( )

Definition at line 67 of file visual-simulator-impl.cc.

Member Function Documentation

◆ Cancel()

void ns3::VisualSimulatorImpl::Cancel ( const EventId id)
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
[in]idthe event to cancel

Implements ns3::SimulatorImpl.

Definition at line 204 of file visual-simulator-impl.cc.

References m_simulator.

◆ Destroy()

void ns3::VisualSimulatorImpl::Destroy ( )
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 90 of file visual-simulator-impl.cc.

References m_simulator.

◆ DoDispose()

void ns3::VisualSimulatorImpl::DoDispose ( void  )
protectedvirtual

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 overridden 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 72 of file visual-simulator-impl.cc.

References ns3::Object::DoDispose(), and m_simulator.

+ Here is the call graph for this function:

◆ GetContext()

uint32_t ns3::VisualSimulatorImpl::GetContext ( void  ) const
virtual

Get the current simulation context.

The simulation context is the ns-3 notion of a Logical Process. Events in a single context should only modify state associated with that context. Events for objects in other contexts should be scheduled with ScheduleWithContext() to track the context switches. In other words, events in different contexts should be mutually thread safe, by not modify overlapping model state.

In circumstances where the context can't be determined, such as during object initialization, the enum value NO_CONTEXT should be used.

Returns
The current simulation context

Implements ns3::SimulatorImpl.

Definition at line 222 of file visual-simulator-impl.cc.

References m_simulator.

◆ GetDelayLeft()

Time ns3::VisualSimulatorImpl::GetDelayLeft ( const EventId id) const
virtual

Get the remaining time until this event will execute.

Parameters
[in]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 192 of file visual-simulator-impl.cc.

References m_simulator.

◆ GetEventCount()

uint64_t ns3::VisualSimulatorImpl::GetEventCount ( void  ) const
virtual

Get the number of events executed.

Returns
The total number of events executed.

Implements ns3::SimulatorImpl.

Definition at line 228 of file visual-simulator-impl.cc.

References m_simulator.

◆ GetMaximumSimulationTime()

Time ns3::VisualSimulatorImpl::GetMaximumSimulationTime ( void  ) const
virtual

Get the maximum representable simulation time.

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 216 of file visual-simulator-impl.cc.

References m_simulator.

◆ GetSim()

Ptr<SimulatorImpl> ns3::VisualSimulatorImpl::GetSim ( )
private

get the simulator implementation

◆ GetSystemId()

uint32_t ns3::VisualSimulatorImpl::GetSystemId ( void  ) const
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.

Returns
The system id for this simulator.

Implements ns3::SimulatorImpl.

Definition at line 103 of file visual-simulator-impl.cc.

References m_simulator.

◆ GetTypeId()

TypeId ns3::VisualSimulatorImpl::GetTypeId ( void  )
static

◆ IsExpired()

bool ns3::VisualSimulatorImpl::IsExpired ( const EventId id) const
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.

Parameters
[in]idThe event to test for expiration.
Returns
true if the event has expired, false otherwise.

Implements ns3::SimulatorImpl.

Definition at line 210 of file visual-simulator-impl.cc.

References m_simulator.

◆ IsFinished()

bool ns3::VisualSimulatorImpl::IsFinished ( void  ) const
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()).

Returns
true if no more events or stop time reached.

Implements ns3::SimulatorImpl.

Definition at line 109 of file visual-simulator-impl.cc.

References m_simulator.

◆ NotifyConstructionCompleted()

void ns3::VisualSimulatorImpl::NotifyConstructionCompleted ( void  )
protectedvirtual

Notifier called once the ObjectBase is fully constructed.

This method is invoked once all member attributes have been initialized. Subclasses can override this method to be notified of this event but if they do this, they must chain up to their parent's NotifyConstructionCompleted method.

Reimplemented from ns3::ObjectBase.

Definition at line 83 of file visual-simulator-impl.cc.

References ns3::ObjectFactory::Create(), m_simulator, and m_simulatorImplFactory.

+ Here is the call graph for this function:

◆ Now()

Time ns3::VisualSimulatorImpl::Now ( void  ) const
virtual

Return the current simulation virtual time.

Returns
The current virtual time.

Implements ns3::SimulatorImpl.

Definition at line 186 of file visual-simulator-impl.cc.

References m_simulator.

◆ Remove()

void ns3::VisualSimulatorImpl::Remove ( const EventId id)
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
[in]idThe event to remove from the list of scheduled events.

Implements ns3::SimulatorImpl.

Definition at line 198 of file visual-simulator-impl.cc.

References m_simulator.

◆ Run()

void ns3::VisualSimulatorImpl::Run ( void  )
virtual

Run the simulation.

The simulation will run until one of:

  • No events are present anymore
  • The user called Simulator::Stop
  • The user called Simulator::Stop with a 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 115 of file visual-simulator-impl.cc.

◆ RunRealSimulator()

void ns3::VisualSimulatorImpl::RunRealSimulator ( void  )

calls Run() in the wrapped simulator

Definition at line 234 of file visual-simulator-impl.cc.

References m_simulator.

◆ Schedule()

EventId ns3::VisualSimulatorImpl::Schedule ( Time const &  delay,
EventImpl event 
)
virtual

Schedule a future event execution (in the same context).

Parameters
[in]delayDelay until the event expires.
[in]eventThe event to schedule.
Returns
A unique identifier for the newly-scheduled event.

Implements ns3::SimulatorImpl.

Definition at line 162 of file visual-simulator-impl.cc.

References m_simulator.

◆ ScheduleDestroy()

EventId ns3::VisualSimulatorImpl::ScheduleDestroy ( EventImpl event)
virtual

Schedule an event to run at the end of the simulation, after the Stop() time or condition has been reached.

Parameters
[in]eventThe event to schedule.
Returns
A unique identifier for the newly-scheduled event.

Implements ns3::SimulatorImpl.

Definition at line 180 of file visual-simulator-impl.cc.

References m_simulator.

◆ ScheduleNow()

EventId ns3::VisualSimulatorImpl::ScheduleNow ( EventImpl event)
virtual

Schedule an event to run at the current virtual time.

Parameters
[in]eventThe event to schedule.
Returns
A unique identifier for the newly-scheduled event.

Implements ns3::SimulatorImpl.

Definition at line 174 of file visual-simulator-impl.cc.

References m_simulator.

◆ ScheduleWithContext()

void ns3::VisualSimulatorImpl::ScheduleWithContext ( uint32_t  context,
Time const &  delay,
EventImpl event 
)
virtual

Schedule a future event execution (in a different context).

This method is thread-safe: it can be called from any thread.

Parameters
[in]delayDelay until the event expires.
[in]contextEvent context.
[in]eventThe event to schedule.

Implements ns3::SimulatorImpl.

Definition at line 168 of file visual-simulator-impl.cc.

References m_simulator.

◆ SetScheduler()

void ns3::VisualSimulatorImpl::SetScheduler ( ObjectFactory  schedulerFactory)
virtual

Set the Scheduler to be used to manage the event list.

Parameters
[in]schedulerFactoryA new event scheduler factory.

The event scheduler can be set at any time: the events scheduled in the previous scheduler will be transferred to the new scheduler before we start to use it.

Implements ns3::SimulatorImpl.

Definition at line 96 of file visual-simulator-impl.cc.

References m_simulator.

◆ Stop() [1/2]

void ns3::VisualSimulatorImpl::Stop ( Time const &  delay)
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.

Parameters
[in]delayThe stop time, relative to the current time.

Implements ns3::SimulatorImpl.

Definition at line 153 of file visual-simulator-impl.cc.

References m_simulator.

◆ Stop() [2/2]

void ns3::VisualSimulatorImpl::Stop ( void  )
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 147 of file visual-simulator-impl.cc.

References m_simulator.

Member Data Documentation

◆ m_simulator

◆ m_simulatorImplFactory

ObjectFactory ns3::VisualSimulatorImpl::m_simulatorImplFactory
private

simulator implementation factory

Definition at line 86 of file visual-simulator-impl.h.

Referenced by GetTypeId(), and NotifyConstructionCompleted().


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