simulator.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005 INRIA
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
 
#ifndef SIMULATOR_H
#define SIMULATOR_H
 
#include "event-id.h"
#include "event-impl.h"
#include "make-event.h"
#include "nstime.h"
#include "object-factory.h"
 
#include <stdint.h>
#include <string>
 
namespace ns3
{
 
class SimulatorImpl;
class Scheduler;
 
class Simulator
{
  public:
    // Delete default constructor and destructor to avoid misuse
    Simulator() = delete;
    ~Simulator() = delete;
 
    static void SetImplementation(Ptr<SimulatorImpl> impl);
 
    static Ptr<SimulatorImpl> GetImplementation();
 
    static void SetScheduler(ObjectFactory schedulerFactory);
 
    static void Destroy();
 
    static bool IsFinished();
 
    static void Run();
 
    static void Stop();
 
    static EventId Stop(const Time& delay);
 
    static EventId GetStopEvent();
 
    static uint32_t GetContext();
 
    enum : uint32_t
    {
        NO_CONTEXT = 0xffffffff
    };
 
    static uint64_t GetEventCount();
 
    template <typename FUNC,
              std::enable_if_t<!std::is_convertible_v<FUNC, Ptr<EventImpl>>, int> = 0,
              std::enable_if_t<!std::is_function_v<std::remove_pointer_t<FUNC>>, int> = 0,
              typename... Ts>
    static EventId Schedule(const Time& delay, FUNC f, Ts&&... args);
 
    template <typename... Us, typename... Ts>
    static EventId Schedule(const Time& delay, void (*f)(Us...), Ts&&... args); // Schedule events (in the same context) to run at a future time.
 
    template <typename FUNC,
              std::enable_if_t<!std::is_convertible_v<FUNC, Ptr<EventImpl>>, int> = 0,
              std::enable_if_t<!std::is_function_v<std::remove_pointer_t<FUNC>>, int> = 0,
              typename... Ts>
    static void ScheduleWithContext(uint32_t context, const Time& delay, FUNC f, Ts&&... args);
 
    template <typename... Us, typename... Ts>
    static void ScheduleWithContext(uint32_t context,
                                    const Time& delay,
                                    void (*f)(Us...),
                                    Ts&&... args); // Schedule events (in a different context) to run now or at a future time.
 
    template <typename FUNC,
              std::enable_if_t<!std::is_convertible_v<FUNC, Ptr<EventImpl>>, int> = 0,
              std::enable_if_t<!std::is_function_v<std::remove_pointer_t<FUNC>>, int> = 0,
              typename... Ts>
    static EventId ScheduleNow(FUNC f, Ts&&... args);
 
    template <typename... Us, typename... Ts>
    static EventId ScheduleNow(void (*f)(Us...), Ts&&... args);
 // Schedule events (in the same context) to run now.
 
    template <typename FUNC,
              std::enable_if_t<!std::is_convertible_v<FUNC, Ptr<EventImpl>>, int> = 0,
              std::enable_if_t<!std::is_function_v<std::remove_pointer_t<FUNC>>, int> = 0,
              typename... Ts>
    static EventId ScheduleDestroy(FUNC f, Ts&&... args);
 
    template <typename... Us, typename... Ts>
    static EventId ScheduleDestroy(void (*f)(Us...), Ts&&... args);
 // Schedule events to run when Simulator:Destroy() is called.
 
    static void Remove(const EventId& id);
 
    static void Cancel(const EventId& id);
 
    static bool IsExpired(const EventId& id);
 
    static Time Now();
 
    static Time GetDelayLeft(const EventId& id);
 
    static Time GetMaximumSimulationTime();
 
    static EventId Schedule(const Time& delay, const Ptr<EventImpl>& event);
 
    static void ScheduleWithContext(uint32_t context, const Time& delay, EventImpl* event);
 
    static EventId ScheduleDestroy(const Ptr<EventImpl>& event);
 
    static EventId ScheduleNow(const Ptr<EventImpl>& event);
 
    static uint32_t GetSystemId();
 
  private:
    static EventId DoSchedule(const Time& delay, EventImpl* event);
    static EventId DoScheduleNow(EventImpl* event);
    static EventId DoScheduleDestroy(EventImpl* event);
 
    static EventId m_stopEvent;
 
}; // class Simulator
 
Time Now();
 
} // namespace ns3
 
/********************************************************************
 *  Implementation of the templates declared above.
 ********************************************************************/
 
namespace ns3
{
 
// Doxygen has trouble with static template functions in a class:
// it treats the in-class declaration as different from the
// out of class definition, so makes two entries in the member list.  Ugh
 
template <typename FUNC,
          std::enable_if_t<!std::is_convertible_v<FUNC, Ptr<EventImpl>>, int>,
          std::enable_if_t<!std::is_function_v<std::remove_pointer_t<FUNC>>, int>,
          typename... Ts>
EventId
Simulator::Schedule(const Time& delay, FUNC f, Ts&&... args)
{
    return DoSchedule(delay, MakeEvent(f, std::forward<Ts>(args)...));
}
 
template <typename... Us, typename... Ts>
EventId
Simulator::Schedule(const Time& delay, void (*f)(Us...), Ts&&... args)
{
    return DoSchedule(delay, MakeEvent(f, std::forward<Ts>(args)...));
}
 
template <typename FUNC,
          std::enable_if_t<!std::is_convertible_v<FUNC, Ptr<EventImpl>>, int>,
          std::enable_if_t<!std::is_function_v<std::remove_pointer_t<FUNC>>, int>,
          typename... Ts>
void
Simulator::ScheduleWithContext(uint32_t context, const Time& delay, FUNC f, Ts&&... args)
{
    return ScheduleWithContext(context, delay, MakeEvent(f, std::forward<Ts>(args)...));
}
 
template <typename... Us, typename... Ts>
void
Simulator::ScheduleWithContext(uint32_t context, const Time& delay, void (*f)(Us...), Ts&&... args)
{
    return ScheduleWithContext(context, delay, MakeEvent(f, std::forward<Ts>(args)...));
}
 
template <typename FUNC,
          std::enable_if_t<!std::is_convertible_v<FUNC, Ptr<EventImpl>>, int>,
          std::enable_if_t<!std::is_function_v<std::remove_pointer_t<FUNC>>, int>,
          typename... Ts>
EventId
Simulator::ScheduleNow(FUNC f, Ts&&... args)
{
    return DoScheduleNow(MakeEvent(f, std::forward<Ts>(args)...));
}
 
template <typename... Us, typename... Ts>
EventId
Simulator::ScheduleNow(void (*f)(Us...), Ts&&... args)
{
    return DoScheduleNow(MakeEvent(f, std::forward<Ts>(args)...));
}
 
template <typename FUNC,
          std::enable_if_t<!std::is_convertible_v<FUNC, Ptr<EventImpl>>, int>,
          std::enable_if_t<!std::is_function_v<std::remove_pointer_t<FUNC>>, int>,
          typename... Ts>
EventId
Simulator::ScheduleDestroy(FUNC f, Ts&&... args)
{
    return DoScheduleDestroy(MakeEvent(f, std::forward<Ts>(args)...));
}
 
template <typename... Us, typename... Ts>
EventId
Simulator::ScheduleDestroy(void (*f)(Us...), Ts&&... args)
{
    return DoScheduleDestroy(MakeEvent(f, std::forward<Ts>(args)...));
}
 
} // namespace ns3
 
#endif /* SIMULATOR_H */