libMesh::Singleton Class Reference

Base class for all library singleton objects. More...

#include <libmesh_singleton.h>

Inheritance diagram for libMesh::Singleton:

Classes
class	Setup
	Abstract base class for runtime singleton setup. More...

Static Public Member Functions
static void	setup ()
	Setup function. More...
static void	cleanup ()
	Cleanup function. More...

Protected Member Functions
	Singleton ()
	Constructor. More...
virtual	~Singleton ()
	Destructor. More...

Detailed Description

Base class for all library singleton objects.

Author

Benjamin S. Kirk

Date

2013

Base class for all library singleton objects.

Definition at line 35 of file libmesh_singleton.h.

Constructor & Destructor Documentation

Singleton()

libMesh::Singleton::Singleton ( )

protected

Constructor.

Adds the derived object to the singleton cache list.

Definition at line 65 of file libmesh_singleton.C.

{
  SingletonMutex::scoped_lock lock(singleton_mtx);
 
  get_singleton_cache().push_back (this);
}

~Singleton()

virtual libMesh::Singleton::~Singleton ( )

inlineprotectedvirtual

Destructor.

Definition at line 47 of file libmesh_singleton.h.

{}

Member Function Documentation

cleanup()

void libMesh::Singleton::cleanup ( )

static

Cleanup function.

Removes all dynamically created Singleton objects.

Definition at line 96 of file libmesh_singleton.C.

{
  SingletonMutex::scoped_lock lock(singleton_mtx);
 
  SingletonList & singleton_cache = get_singleton_cache();
 
  for (auto & item : as_range(singleton_cache.rbegin(),
                              singleton_cache.rend()))
    {
      libmesh_assert (item);
      delete item;
      item = nullptr;
    }
 
  singleton_cache.clear();
}

References libMesh::as_range(), and libMesh::libmesh_assert().

setup()

void libMesh::Singleton::setup ( )

static

Setup function.

Initializes any derived Singleton::Setup objects. objects.

Definition at line 81 of file libmesh_singleton.C.

{
  SingletonMutex::scoped_lock lock(setup_mtx);
 
  SetupList & setup_cache = get_setup_cache();
 
  for (auto & item : setup_cache)
    {
      libmesh_assert (item);
      item->setup();
    }
}

References libMesh::libmesh_assert().

Referenced by libMesh::LibMeshInit::LibMeshInit().

---

The documentation for this class was generated from the following files:

• include/base/libmesh_singleton.h
• src/base/libmesh_singleton.C