libMesh
Classes | Static Public Member Functions | Protected Member Functions | List of all members
libMesh::Singleton Class Reference

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

#include <libmesh_singleton.h>

Inheritance diagram for libMesh::Singleton:
[legend]

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.

◆ ~Singleton()

virtual libMesh::Singleton::~Singleton ( )
protectedvirtual

Destructor.

Definition at line 47 of file libmesh_singleton.h.

47 {}

Member Function Documentation

◆ cleanup()

static void libMesh::Singleton::cleanup ( )
static

Cleanup function.

Removes all dynamically created Singleton objects.

◆ setup()

static void libMesh::Singleton::setup ( )
static

Setup function.

Initializes any derived Singleton::Setup objects. objects.


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