A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ns3::VisualSimulatorImpl Class Reference
Visualizer | Core » Simulator

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 () override
 
void Cancel (const EventId &id) override
 Set the cancel bit on this event: the event's associated function will not be invoked when it expires. More...
 
void Destroy () override
 Execute the events scheduled with ScheduleDestroy().
More...
 
uint32_t GetContext () const override
 Get the current simulation context. More...
 
Time GetDelayLeft (const EventId &id) const override
 Get the remaining time until this event will execute. More...
 
uint64_t GetEventCount () const override
 Get the number of events executed. More...
 
Time GetMaximumSimulationTime () const override
 Get the maximum representable simulation time. More...
 
uint32_t GetSystemId () const override
 Get the system id of this simulator. More...
 
bool IsExpired (const EventId &id) const override
 Check if an event has already run or been cancelled. More...
 
bool IsFinished () const override
 Check if the simulation should finish. More...
 
Time Now () const override
 Return the current simulation virtual time. More...
 
void Remove (const EventId &id) override
 Remove an event from the event list. More...
 
void Run () override
 Run the simulation. More...
 
void RunRealSimulator ()
 calls Run() in the wrapped simulator More...
 
EventId Schedule (const Time &delay, EventImpl *event) override
 Schedule a future event execution (in the same context). More...
 
EventId ScheduleDestroy (EventImpl *event) override
 Schedule an event to run at the end of the simulation, after the Stop() time or condition has been reached. More...
 
EventId ScheduleNow (EventImpl *event) override
 Schedule an event to run at the current virtual time. More...
 
void ScheduleWithContext (uint32_t context, const Time &delay, EventImpl *event) override
 Schedule a future event execution (in a different context). More...
 
void SetScheduler (ObjectFactory schedulerFactory) override
 Set the Scheduler to be used to manage the event list. More...
 
void Stop () override
 Tell the Simulator the calling event should be the last one executed. More...
 
EventId Stop (const Time &delay) override
 Schedule the time delay until the Simulator should stop. More...
 
- Public Member Functions inherited from ns3::SimulatorImpl
virtual void PreEventHook (const EventId &id)
 Hook called before processing each event. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< Object > GetObject () 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< Object > GetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCount & operator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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 errors. 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 ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::SimulatorImpl
static TypeId GetTypeId ()
 Get the registered TypeId for this class. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Protected Member Functions

void DoDispose () override
 Destructor implementation. More...
 
void NotifyConstructionCompleted () override
 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 ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 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 Attributes

Ptr< SimulatorImpl > m_simulator
 the simulator implementation More...
 
ObjectFactory m_simulatorImplFactory
 simulator implementation factory More...
 

Additional Inherited Members

- Related Functions inherited from ns3::ObjectBase
static TypeId GetObjectIid ()
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...
 

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 43 of file visual-simulator-impl.h.

Constructor & Destructor Documentation

◆ VisualSimulatorImpl()

ns3::VisualSimulatorImpl::VisualSimulatorImpl ( )

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

References ns3::PacketMetadata::Enable().

+ Here is the call graph for this function:

◆ ~VisualSimulatorImpl()

ns3::VisualSimulatorImpl::~VisualSimulatorImpl ( )
override

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

Member Function Documentation

◆ Cancel()

void ns3::VisualSimulatorImpl::Cancel ( const EventId &  id)
overridevirtual

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

References m_simulator.

◆ Destroy()

void ns3::VisualSimulatorImpl::Destroy ( )
overridevirtual

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

References m_simulator.

◆ DoDispose()

void ns3::VisualSimulatorImpl::DoDispose ( void  )
overrideprotectedvirtual

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 76 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 ( ) const
overridevirtual

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

References m_simulator.

◆ GetDelayLeft()

Time ns3::VisualSimulatorImpl::GetDelayLeft ( const EventId &  id) const
overridevirtual

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

References m_simulator.

◆ GetEventCount()

uint64_t ns3::VisualSimulatorImpl::GetEventCount ( ) const
overridevirtual

Get the number of events executed.

Returns
The total number of events executed.

Implements ns3::SimulatorImpl.

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

References m_simulator.

◆ GetMaximumSimulationTime()

Time ns3::VisualSimulatorImpl::GetMaximumSimulationTime ( ) const
overridevirtual

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

References m_simulator.

◆ GetSystemId()

uint32_t ns3::VisualSimulatorImpl::GetSystemId ( ) const
overridevirtual

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

References m_simulator.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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

References ns3::anonymous_namespace{visual-simulator-impl.cc}::GetDefaultSimulatorImplFactory(), m_simulatorImplFactory, ns3::MakeObjectFactoryAccessor(), ns3::MakeObjectFactoryChecker(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsExpired()

bool ns3::VisualSimulatorImpl::IsExpired ( const EventId &  id) const
overridevirtual

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

References m_simulator.

◆ IsFinished()

bool ns3::VisualSimulatorImpl::IsFinished ( ) const
overridevirtual

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

References m_simulator.

◆ NotifyConstructionCompleted()

void ns3::VisualSimulatorImpl::NotifyConstructionCompleted ( )
overrideprotectedvirtual

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 87 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 ( ) const
overridevirtual

Return the current simulation virtual time.

Returns
The current virtual time.

Implements ns3::SimulatorImpl.

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

References m_simulator.

◆ Remove()

void ns3::VisualSimulatorImpl::Remove ( const EventId &  id)
overridevirtual

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

References m_simulator.

◆ Run()

void ns3::VisualSimulatorImpl::Run ( )
overridevirtual

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

◆ RunRealSimulator()

void ns3::VisualSimulatorImpl::RunRealSimulator ( )

calls Run() in the wrapped simulator

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

References m_simulator.

◆ Schedule()

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

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

References m_simulator.

◆ ScheduleDestroy()

EventId ns3::VisualSimulatorImpl::ScheduleDestroy ( EventImpl *  event)
overridevirtual

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

References m_simulator.

◆ ScheduleNow()

EventId ns3::VisualSimulatorImpl::ScheduleNow ( EventImpl *  event)
overridevirtual

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

References m_simulator.

◆ ScheduleWithContext()

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

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

References m_simulator.

◆ SetScheduler()

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

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

References m_simulator.

◆ Stop() [1/2]

void ns3::VisualSimulatorImpl::Stop ( )
overridevirtual

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

References m_simulator.

◆ Stop() [2/2]

EventId ns3::VisualSimulatorImpl::Stop ( const Time &  delay)
overridevirtual

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.
Returns
The stop EventId.

Implements ns3::SimulatorImpl.

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

References m_simulator.

Member Data Documentation

◆ m_simulator

Ptr<SimulatorImpl> ns3::VisualSimulatorImpl::m_simulator
private

the simulator implementation

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

Referenced by Cancel(), Destroy(), DoDispose(), GetContext(), GetDelayLeft(), GetEventCount(), GetMaximumSimulationTime(), GetSystemId(), IsExpired(), IsFinished(), NotifyConstructionCompleted(), Now(), Remove(), RunRealSimulator(), Schedule(), ScheduleDestroy(), ScheduleNow(), ScheduleWithContext(), SetScheduler(), and Stop().

◆ m_simulatorImplFactory

ObjectFactory ns3::VisualSimulatorImpl::m_simulatorImplFactory
private

simulator implementation factory

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

Referenced by GetTypeId(), and NotifyConstructionCompleted().

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