libMesh
libmesh_singleton.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2013 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License, or (at your option) any later version.
8 
9 // This library 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 GNU
12 // Lesser General Public License for more details.
13 
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 
18 
19 
20 #ifndef LIBMESH_LIBMESH_SINGLETON_H
21 #define LIBMESH_LIBMESH_SINGLETON_H
22 
23 #include "libmesh/libmesh_common.h"
24 
25 namespace libMesh
26 {
27 
35 class Singleton
36 {
37 protected:
38 
42  Singleton();
43 
47  virtual ~Singleton() {}
48 
49 public:
50 
55  class Setup
56  {
57  protected:
61  Setup ();
62 
63  public:
67  virtual ~Setup() {}
68 
73  virtual void setup () = 0;
74  };
75 
80  static void setup();
81 
86  static void cleanup();
87 };
88 
89 } // namespace libMesh
90 
91 #endif // LIBMESH_LIBMESH_SINGLETON_H
Base class for all library singleton objects.
Singleton()
Constructor.
virtual ~Setup()
Destructor.
The libMesh namespace provides an interface to certain functionality in the library.
virtual void setup()=0
Setup method.
Abstract base class for runtime singleton setup.
virtual ~Singleton()
Destructor.
static void cleanup()
Cleanup function.