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 
29 namespace ns3 {
30 
42 template <typename T>
43 class SimulationSingleton
44 {
45 public:
54  static T *Get (void);
55 
56 private:
57 
67  static T **GetObject (void);
68 
70  static void DeleteObject (void);
71 
81  SimulationSingleton<T> (void);
82 
84  SimulationSingleton<T> (const SimulationSingleton<T> &);
89  SimulationSingleton<T> operator = (const SimulationSingleton<T> &);
92 };
93 
94 } // namespace ns3
95 
96 
97 /********************************************************************
98  * Implementation of the templates declared above.
99  ********************************************************************/
100 
101 #include "simulator.h"
102 
103 namespace ns3 {
104 
105 template <typename T>
106 T *
107 SimulationSingleton<T>::Get (void)
108 {
109  T ** ppobject = GetObject ();
110  return *ppobject;
111 }
112 
113 template <typename T>
114 T **
115 SimulationSingleton<T>::GetObject (void)
116 {
117  static T *pobject = 0;
118  if (pobject == 0)
119  {
120  pobject = new T ();
121  Simulator::ScheduleDestroy (&SimulationSingleton<T>::DeleteObject);
122  }
123  return &pobject;
124 }
125 
126 template <typename T>
127 void
128 SimulationSingleton<T>::DeleteObject (void)
129 {
130  T **ppobject = GetObject ();
131  delete (*ppobject);
132  *ppobject = 0;
133 }
134 
135 } // namespace ns3
136 
137 
138 #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:43
simulator.h
ns3::Simulator declaration.
ns3::SimulationSingleton::DeleteObject
static void DeleteObject(void)
Delete the static instance.
Definition: simulation-singleton.h:128
ns3::SimulationSingleton::Get
static T * Get(void)
Get a pointer to the singleton instance.
Definition: simulation-singleton.h:107
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::SimulationSingleton::GetObject
static T ** GetObject(void)
Get the singleton object, creating a new one if it doesn&#39;t exist yet.
Definition: simulation-singleton.h:115
ns3::Simulator::ScheduleDestroy
static EventId ScheduleDestroy(MEM mem_ptr, OBJ obj)
Schedule an event to expire when Simulator::Destroy is called.
Definition: simulator.h:1677
ns3::SimulationSingleton::operator=
SimulationSingleton< T > operator=(const SimulationSingleton< T > &)
Assignment.
Generated on Wed Nov 7 2018 10:01:50 for ns-3 by   doxygen 1.8.14