/usr/include/ns3.27/ns3/simulation-singleton.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2007 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 SIMULATION_SINGLETON_H
#define SIMULATION_SINGLETON_H
/**
* \file
* \ingroup core
* ns3::SimulationSingleton declaration and template implementation.
*/
namespace ns3 {
/**
* \ingroup core
* This singleton class template ensures that the type
* for which we want a singleton has a lifetime bounded
* by the simulation run lifetime. That it, the underlying
* type will be automatically deleted upon a call
* to Simulator::Destroy.
*
* For a singleton with a lifetime bounded by the process,
* not the simulation run, see Singleton.
*/
template <typename T>
class SimulationSingleton
{
public:
/**
* Get a pointer to the singleton instance.
*
* This instance will be automatically deleted when the
* simulation is destroyed by a call to Simulator::Destroy.
*
* \returns A pointer to the singleton instance.
*/
static T *Get (void);
private:
/**
* Get the singleton object, creating a new one if it doesn't exist yet.
*
* \internal
* When a new object is created, this method schedules it's own
* destruction using Simulator::ScheduleDestroy().
*
* \returns The address of the pointer holding the static instance.
*/
static T **GetObject (void);
/** Delete the static instance. */
static void DeleteObject (void);
/**
* \name %Singleton pattern
* Private constructor, copy and assignment operator.
*
* Note these do not have to be implemented, since they are
* never called.
*/
/**@{*/
/** Default constructor */
SimulationSingleton<T> (void);
/** Copy constructor. */
SimulationSingleton<T> (const SimulationSingleton<T> &);
/**
* Assignment.
* \returns The Singleton.
*/
SimulationSingleton<T> operator = (const SimulationSingleton<T> &);
/**@}*/
};
} // namespace ns3
/********************************************************************
* Implementation of the templates declared above.
********************************************************************/
#include "simulator.h"
namespace ns3 {
template <typename T>
T *
SimulationSingleton<T>::Get (void)
{
T ** ppobject = GetObject ();
return *ppobject;
}
template <typename T>
T **
SimulationSingleton<T>::GetObject (void)
{
static T *pobject = 0;
if (pobject == 0)
{
pobject = new T ();
Simulator::ScheduleDestroy (&SimulationSingleton<T>::DeleteObject);
}
return &pobject;
}
template <typename T>
void
SimulationSingleton<T>::DeleteObject (void)
{
T **ppobject = GetObject ();
delete (*ppobject);
*ppobject = 0;
}
} // namespace ns3
#endif /* SIMULATION_SINGLETON_H */
|