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 &ev)
	Set the cancel bit on this event: the event's associated function will not be invoked when it expires. More...
virtual void	Destroy ()
	This method is typically invoked at the end of a simulation to avoid false-positive reports by a leak checker. More...
virtual uint32_t	GetContext (void) const
virtual Time	GetDelayLeft (const EventId &id) const
virtual Time	GetMaximumSimulationTime (void) const
virtual uint32_t	GetSystemId (void) const
virtual bool	IsExpired (const EventId &ev) const
	This method has O(1) complexity. More...
virtual bool	IsFinished (void) const
	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. More...
virtual Time	Now (void) const
	Return the "current simulation time". More...
virtual void	Remove (const EventId &ev)
	Remove an event from the event list. More...
virtual void	Run (void)
	Run the simulation until one of: More...
void	RunRealSimulator (void)
	calls Run() in the wrapped simulator More...
virtual EventId	Schedule (Time const &time, EventImpl *event)
virtual EventId	ScheduleDestroy (EventImpl *event)
virtual EventId	ScheduleNow (EventImpl *event)
virtual void	ScheduleWithContext (uint32_t context, Time const &time, EventImpl *event)
virtual void	SetScheduler (ObjectFactory schedulerFactory)
virtual void	Stop (void)
	If an event invokes this method, it will be the last event scheduled by the Simulator::Run method before returning to the caller. More...
virtual void	Stop (Time const &time)
	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. More...
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	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...
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::SimulatorImpl
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...
Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Member Functions
void	DoDispose ()
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...
virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

Private Member Functions
Ptr< SimulatorImpl >	GetSim ()

Private Attributes
Ptr< SimulatorImpl >	m_simulator
ObjectFactory	m_simulatorImplFactory

Detailed Description

A replacement simulator that starts the visualizer.

Internal:

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

Constructor & Destructor Documentation

ns3::VisualSimulatorImpl::VisualSimulatorImpl

(

)

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

ns3::VisualSimulatorImpl::~VisualSimulatorImpl

(

)

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

Member Function Documentation

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

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

References m_simulator.

void ns3::VisualSimulatorImpl::Destroy ( )

virtual

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

References m_simulator.

void ns3::VisualSimulatorImpl::DoDispose ( void  )

protectedvirtual

This method is called by Object::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 71 of file visual-simulator-impl.cc.

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

Here is the call graph for this function:

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

virtual

Returns

the current simulation context

Implements ns3::SimulatorImpl.

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

References m_simulator.

Time ns3::VisualSimulatorImpl::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.

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

References m_simulator.

Time ns3::VisualSimulatorImpl::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.

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

References m_simulator.

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

private

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

virtual

Returns

the system id for this simulator; used for MPI or other distributed simulations

Implements ns3::SimulatorImpl.

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

References m_simulator.

TypeId ns3::VisualSimulatorImpl::GetTypeId ( void  )

static

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

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

Here is the call graph for this function:

bool ns3::VisualSimulatorImpl::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.

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

References m_simulator.

bool ns3::VisualSimulatorImpl::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.

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

References m_simulator.

void ns3::VisualSimulatorImpl::NotifyConstructionCompleted ( void  )

protectedvirtual

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

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

Here is the call graph for this function:

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

virtual

Return the "current simulation time".

Implements ns3::SimulatorImpl.

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

References m_simulator.

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

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

References m_simulator.

void ns3::VisualSimulatorImpl::Run ( void  )

virtual

Run the simulation until one of:

• no events are present anymore
• the user called Simulator::Stop
• the user called Simulator::Stop with 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 114 of file visual-simulator-impl.cc.

void ns3::VisualSimulatorImpl::RunRealSimulator

(

void

)

calls Run() in the wrapped simulator

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

References m_simulator.

EventId ns3::VisualSimulatorImpl::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.

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

References m_simulator.

EventId ns3::VisualSimulatorImpl::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.

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

References m_simulator.

EventId ns3::VisualSimulatorImpl::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.

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

References m_simulator.

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

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

References m_simulator.

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

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

References m_simulator.

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

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

References m_simulator.

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

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

References m_simulator.

Member Data Documentation

Ptr<SimulatorImpl> ns3::VisualSimulatorImpl::m_simulator

private

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

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

ObjectFactory ns3::VisualSimulatorImpl::m_simulatorImplFactory

private

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

Referenced by GetTypeId(), and NotifyConstructionCompleted().

---

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

• src/visualizer/model/visual-simulator-impl.h
• src/visualizer/model/visual-simulator-impl.cc