A Discrete-Event Network Simulator
API
simulator-impl.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005,2006 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #ifndef SIMULATOR_IMPL_H
22 #define SIMULATOR_IMPL_H
23 
24 #include "event-impl.h"
25 #include "event-id.h"
26 #include "nstime.h"
27 #include "object.h"
28 #include "object-factory.h"
29 #include "ptr.h"
30 
31 namespace ns3 {
32 
33 class Scheduler;
34 
42 class SimulatorImpl : public Object
43 {
44 public:
45 
50  static TypeId GetTypeId (void);
51 
61  virtual void Destroy () = 0;
71  virtual bool IsFinished (void) const = 0;
80  virtual void Stop (void) = 0;
90  virtual void Stop (Time const &time) = 0;
98  virtual EventId Schedule (Time const &time, EventImpl *event) = 0;
107  virtual void ScheduleWithContext (uint32_t context, Time const &time, EventImpl *event) = 0;
114  virtual EventId ScheduleNow (EventImpl *event) = 0;
122  virtual EventId ScheduleDestroy (EventImpl *event) = 0;
135  virtual void Remove (const EventId &id) = 0;
149  virtual void Cancel (const EventId &id) = 0;
164  virtual bool IsExpired (const EventId &id) const = 0;
175  virtual void Run (void) = 0;
181  virtual Time Now (void) const = 0;
190  virtual Time GetDelayLeft (const EventId &id) const = 0;
199  virtual Time GetMaximumSimulationTime (void) const = 0;
209  virtual void SetScheduler (ObjectFactory schedulerFactory) = 0;
217  virtual uint32_t GetSystemId () const = 0;
223  virtual uint32_t GetContext (void) const = 0;
224 };
225 
226 } // namespace ns3
227 
228 #endif /* SIMULATOR_IMPL_H */
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:95
ns3::SimulatorImpl::ScheduleWithContext
virtual void ScheduleWithContext(uint32_t context, Time const &time, EventImpl *event)=0
Schedule a future event execution (in a different context).
ns3::SimulatorImpl::GetTypeId
static TypeId GetTypeId(void)
Get the registered TypeId for this class.
Definition: simulator-impl.cc:30
event-impl.h
ns3::EventImpl declarations.
ns3::SimulatorImpl::IsExpired
virtual bool IsExpired(const EventId &id) const =0
Check if an event has already run or been cancelled.
ptr.h
Smart pointer implementation.
ns3::SimulatorImpl::Now
virtual Time Now(void) const =0
Return the current simulation virtual time.
object-factory.h
ns3::ObjectFactory class declaration.
ns3::SimulatorImpl::ScheduleNow
virtual EventId ScheduleNow(EventImpl *event)=0
Schedule an event to run at the current virtual time.
ns3::SimulatorImpl::SetScheduler
virtual void SetScheduler(ObjectFactory schedulerFactory)=0
Set the Scheduler to be used to manage the event list.
ns3::SimulatorImpl::Cancel
virtual void Cancel(const EventId &id)=0
Set the cancel bit on this event: the event's associated function will not be invoked when it expires...
ns3::SimulatorImpl::Run
virtual void Run(void)=0
Run the simulation.
ns3::SimulatorImpl::GetMaximumSimulationTime
virtual Time GetMaximumSimulationTime(void) const =0
Get the maximum representable simulation time.
ns3::SimulatorImpl::IsFinished
virtual bool IsFinished(void) const =0
Check if the simulation should finish.
ns3::SimulatorImpl::Remove
virtual void Remove(const EventId &id)=0
Remove an event from the event list.
ns3::SimulatorImpl::GetDelayLeft
virtual Time GetDelayLeft(const EventId &id) const =0
Get the remaining time until this event will execute.
ns3::SimulatorImpl::ScheduleDestroy
virtual EventId ScheduleDestroy(EventImpl *event)=0
Schedule an event to run at the end of the simulation, after the Stop() time or condition has been re...
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::SimulatorImpl::Schedule
virtual EventId Schedule(Time const &time, EventImpl *event)=0
Schedule a future event execution (in the same context).
object.h
ns3::Object class declaration, which is the root of the Object hierarchy and Aggregation.
ns3::ObjectFactory
Instantiate subclasses of ns3::Object.
Definition: object-factory.h:47
ns3::EventImpl
A simulation event.
Definition: event-impl.h:44
ns3::EventId
An identifier for simulation events.
Definition: event-id.h:53
ns3::SimulatorImpl::Destroy
virtual void Destroy()=0
Execute the events scheduled with ScheduleDestroy().
ns3::SimulatorImpl::Stop
virtual void Stop(void)=0
Tell the Simulator the calling event should be the last one executed.
ns3::SimulatorImpl::GetSystemId
virtual uint32_t GetSystemId() const =0
Get the system id of this simulator.
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:87
event-id.h
ns3::EventId declarations.
ns3::SimulatorImpl::GetContext
virtual uint32_t GetContext(void) const =0
Get the current simulation context.
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:51
ns3::SimulatorImpl
The SimulatorImpl base class.
Definition: simulator-impl.h:42