A Discrete-Event Network Simulator
API
simulation-singleton.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2007 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#ifndef SIMULATION_SINGLETON_H
21#define SIMULATION_SINGLETON_H
22
29namespace ns3 {
30
42template <typename T>
43class SimulationSingleton
44{
45public:
46 // Delete default constructor, copy constructor and assignment operator to avoid misuse
47 SimulationSingleton<T> () = delete;
48 SimulationSingleton<T> (const SimulationSingleton<T> &) = delete;
49 SimulationSingleton<T> & operator = (const SimulationSingleton<T> &) = delete;
50
59 static T * Get (void);
60
61private:
62
72 static T ** GetObject (void);
73
75 static void DeleteObject (void);
76};
77
78} // namespace ns3
79
80
81/********************************************************************
82 * Implementation of the templates declared above.
83 ********************************************************************/
84
85#include "simulator.h"
86
87namespace ns3 {
88
89template <typename T>
90T *
91SimulationSingleton<T>::Get (void)
92{
93 T ** ppobject = GetObject ();
94 return *ppobject;
95}
96
97template <typename T>
98T **
99SimulationSingleton<T>::GetObject (void)
100{
101 static T *pobject = 0;
102 if (pobject == 0)
103 {
104 pobject = new T ();
105 Simulator::ScheduleDestroy (&SimulationSingleton<T>::DeleteObject);
106 }
107 return &pobject;
108}
109
110template <typename T>
111void
112SimulationSingleton<T>::DeleteObject (void)
113{
114 T **ppobject = GetObject ();
115 delete (*ppobject);
116 *ppobject = 0;
117}
118
119} // namespace ns3
120
121
122#endif /* SIMULATION_SINGLETON_H */
ns3::SimulationSingleton
This singleton class template ensures that the type for which we want a singleton has a lifetime boun...
Definition: simulation-singleton.h:44
ns3::SimulationSingleton::Get
static T * Get(void)
Get a pointer to the singleton instance.
Definition: simulation-singleton.h:91
ns3::SimulationSingleton::DeleteObject
static void DeleteObject(void)
Delete the static instance.
Definition: simulation-singleton.h:112
ns3::SimulationSingleton::operator=
SimulationSingleton< T > & operator=(const SimulationSingleton< T > &)=delete
ns3::SimulationSingleton::GetObject
static T ** GetObject(void)
Get the singleton object, creating a new one if it doesn't exist yet.
Definition: simulation-singleton.h:99
ns3::Simulator::ScheduleDestroy
static EventId ScheduleDestroy(FUNC f, Ts &&... args)
Schedule an event to run at the end of the simulation, when Simulator::Destroy() is called.
Definition: simulator.h:605
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
simulator.h
ns3::Simulator declaration.