src/simulator/default-simulator-impl.h
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Sat, 04 Jul 2009 08:15:48 +0200
changeset 4654 2eaebe77d66b
parent 4552 8d3801089629
permissions -rw-r--r--
Added tag ns-3.5 for changeset c975274c9707
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3470
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     2
/*
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     3
 * Copyright (c) 2005,2006 INRIA
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     4
 *
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     8
 *
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    12
 * GNU General Public License for more details.
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    13
 *
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    17
 *
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    18
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    19
 */
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    20
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    21
#ifndef DEFAULT_SIMULATOR_IMPL_H
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    22
#define DEFAULT_SIMULATOR_IMPL_H
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    23
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    24
#include "simulator-impl.h"
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    25
#include "scheduler.h"
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    26
#include "event-impl.h"
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    27
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    28
#include "ns3/ptr.h"
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    29
#include "ns3/assert.h"
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    30
#include "ns3/log.h"
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    31
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    32
#include <list>
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    33
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    34
namespace ns3 {
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    35
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    36
  class DefaultSimulatorImpl : public SimulatorImpl
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    37
{
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    38
public:
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    39
  static TypeId GetTypeId (void);
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    40
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    41
  DefaultSimulatorImpl ();
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    42
  ~DefaultSimulatorImpl ();
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    43
3509
ed1383c30766 repeat the virtual keyword in the subclass
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3494
diff changeset
    44
  virtual void Destroy ();
ed1383c30766 repeat the virtual keyword in the subclass
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3494
diff changeset
    45
  virtual bool IsFinished (void) const;
ed1383c30766 repeat the virtual keyword in the subclass
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3494
diff changeset
    46
  virtual Time Next (void) const;
ed1383c30766 repeat the virtual keyword in the subclass
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3494
diff changeset
    47
  virtual void Stop (void);
3808
ace932ee6eef avoid using Ptr<EventImpl>
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3515
diff changeset
    48
  virtual EventId Schedule (Time const &time, EventImpl *event);
ace932ee6eef avoid using Ptr<EventImpl>
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3515
diff changeset
    49
  virtual EventId ScheduleNow (EventImpl *event);
ace932ee6eef avoid using Ptr<EventImpl>
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3515
diff changeset
    50
  virtual EventId ScheduleDestroy (EventImpl *event);
3509
ed1383c30766 repeat the virtual keyword in the subclass
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3494
diff changeset
    51
  virtual void Remove (const EventId &ev);
ed1383c30766 repeat the virtual keyword in the subclass
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3494
diff changeset
    52
  virtual void Cancel (const EventId &ev);
ed1383c30766 repeat the virtual keyword in the subclass
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3494
diff changeset
    53
  virtual bool IsExpired (const EventId &ev) const;
ed1383c30766 repeat the virtual keyword in the subclass
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3494
diff changeset
    54
  virtual void Run (void);
3515
88e9cee20461 Bug #270: Simulator::RunOneEvent
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3509
diff changeset
    55
  virtual void RunOneEvent (void);
3509
ed1383c30766 repeat the virtual keyword in the subclass
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3494
diff changeset
    56
  virtual Time Now (void) const;
ed1383c30766 repeat the virtual keyword in the subclass
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3494
diff changeset
    57
  virtual Time GetDelayLeft (const EventId &id) const;
ed1383c30766 repeat the virtual keyword in the subclass
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3494
diff changeset
    58
  virtual Time GetMaximumSimulationTime (void) const;
ed1383c30766 repeat the virtual keyword in the subclass
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3494
diff changeset
    59
  virtual void SetScheduler (Ptr<Scheduler> scheduler);
3470
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    60
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    61
private:
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    62
  void ProcessOneEvent (void);
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    63
  uint64_t NextTs (void) const;
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    64
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    65
  typedef std::list<EventId> DestroyEvents;
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    66
  DestroyEvents m_destroyEvents;
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    67
  bool m_stop;
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    68
  Ptr<Scheduler> m_events;
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    69
  uint32_t m_uid;
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    70
  uint32_t m_currentUid;
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    71
  uint64_t m_currentTs;
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    72
  // number of events that have been inserted but not yet scheduled,
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    73
  // not counting the "destroy" events; this is used for validation
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    74
  int m_unscheduledEvents;
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    75
};
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    76
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    77
} // namespace ns3
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    78
21022872009d make simulator implementation replaceable via global default value
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    79
#endif /* DEFAULT_SIMULATOR_IMPL_H */