src/core/singleton.h
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Sat, 04 Jul 2009 08:15:48 +0200
changeset 4654 2eaebe77d66b
parent 3190 51fe9001a679
permissions -rw-r--r--
Added tag ns-3.5 for changeset c975274c9707
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
526
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     2
/*
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     3
 * Copyright (c) 2007 INRIA
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     4
 *
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     8
 *
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    12
 * GNU General Public License for more details.
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    13
 *
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    17
 *
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    18
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    19
 */
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    20
#ifndef SINGLETON_H
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    21
#define SINGLETON_H
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    22
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    23
namespace ns3 {
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    24
3190
51fe9001a679 add some doxygen, remove a couple of XXX
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2834
diff changeset
    25
/**
51fe9001a679 add some doxygen, remove a couple of XXX
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2834
diff changeset
    26
 * \brief a template singleton
51fe9001a679 add some doxygen, remove a couple of XXX
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2834
diff changeset
    27
 *
51fe9001a679 add some doxygen, remove a couple of XXX
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2834
diff changeset
    28
 * This template class can be used to implement the singleton pattern.
51fe9001a679 add some doxygen, remove a couple of XXX
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2834
diff changeset
    29
 * The underlying object will be destroyed automatically when the process
51fe9001a679 add some doxygen, remove a couple of XXX
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2834
diff changeset
    30
 * exits. Note that, if you call Singleton::Get again after the object has
51fe9001a679 add some doxygen, remove a couple of XXX
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2834
diff changeset
    31
 * been destroyed, the object will be re-created which will result in a
51fe9001a679 add some doxygen, remove a couple of XXX
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2834
diff changeset
    32
 * memory leak as reported by most memory leak checkers. It is up to the
51fe9001a679 add some doxygen, remove a couple of XXX
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2834
diff changeset
    33
 * user to ensure that Singleton::Get is never called from a static variable
51fe9001a679 add some doxygen, remove a couple of XXX
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2834
diff changeset
    34
 * finalizer.
51fe9001a679 add some doxygen, remove a couple of XXX
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2834
diff changeset
    35
 */
526
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    36
template <typename T>
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    37
class Singleton
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    38
{
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    39
public:
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    40
  static T *Get (void);
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    41
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    42
};
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    43
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    44
} // namespace ns3
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    45
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    46
namespace ns3 {
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    47
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    48
template <typename T>
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    49
T *
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    50
Singleton<T>::Get (void)
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    51
{
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    52
  static T object;
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    53
  return &object;
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    54
}
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    55
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    56
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    57
} // namespace ns3
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    58
01999879c76b a first draft of a component manager
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    59
#endif /* SINGLETON_H */