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

#include <libmesh_singleton.h>

Inheritance diagram for libMesh::Singleton:

Classes
class	Setup

Static Public Member Functions
static void	setup ()

static void	cleanup ()

Protected Member Functions
	Singleton ()

virtual	~Singleton ()

Detailed Description

Base class for all library singleton objects.

Author: Benjamin S. Kirk

Date: 2013

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.

47 {}

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.

References libMesh::as_range().

 {
   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();
 }

◆ setup()

void libMesh::Singleton::setup ( )

static

Setup function. Initializes any derived Singleton::Setup objects. objects.

Definition at line 81 of file libmesh_singleton.C.

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

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

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

Classes

Static Public Member Functions