libMesh
|
This is the base class for enabling reference counting. More...
#include <reference_counter.h>
Public Member Functions | |
~ReferenceCounter () | |
Destructor. More... | |
Static Public Member Functions | |
static std::string | get_info () |
Gets a string containing the reference information. More... | |
static void | print_info (std::ostream &out=libMesh::out) |
Prints the reference information, by default to libMesh::out . More... | |
static unsigned int | n_objects () |
Prints the number of outstanding (created, but not yet destroyed) objects. More... | |
static void | enable_print_counter_info () |
Methods to enable/disable the reference counter output from print_info() More... | |
static void | disable_print_counter_info () |
Protected Types | |
typedef std::map< std::string, std::pair< unsigned int, unsigned int > > | Counts |
Data structure to log the information. More... | |
Protected Member Functions | |
ReferenceCounter () | |
Constructors. More... | |
ReferenceCounter (const ReferenceCounter &) | |
ReferenceCounter (ReferenceCounter &&other) noexcept | |
Move constructor, must be declared noexcept. More... | |
void | increment_constructor_count (const std::string &name) |
Increments the construction counter. More... | |
void | increment_destructor_count (const std::string &name) |
Increments the destruction counter. More... | |
Static Protected Attributes | |
static Counts | _counts |
Actually holds the data. More... | |
static Threads::atomic< unsigned int > | _n_objects |
The number of objects. More... | |
static Threads::spin_mutex | _mutex |
Mutual exclusion object to enable thread-safe reference counting. More... | |
static bool | _enable_print_counter |
Flag to control whether reference count information is printed when print_info is called. More... | |
This is the base class for enabling reference counting.
It should not be used by the user, thus it has a private constructor.
Definition at line 44 of file reference_counter.h.
|
protected |
Data structure to log the information.
The log is identified by the class name.
Definition at line 117 of file reference_counter.h.
|
protected |
Constructors.
Protected so that you cannot instantiate a ReferenceCounter
, only derive from it.
Definition at line 148 of file reference_counter.h.
References _n_objects.
|
protected |
Definition at line 155 of file reference_counter.h.
References _n_objects.
|
protectednoexcept |
Move constructor, must be declared noexcept.
Definition at line 162 of file reference_counter.h.
References _n_objects.
libMesh::ReferenceCounter::~ReferenceCounter | ( | ) |
Destructor.
Definition at line 169 of file reference_counter.h.
References _n_objects.
|
static |
|
static |
Methods to enable/disable the reference counter output from print_info()
|
static |
Gets a string containing the reference information.
|
protected |
Increments the construction counter.
Should be called in the constructor of any derived class that will be reference counted.
Definition at line 181 of file reference_counter.h.
References _counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.
Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().
|
protected |
Increments the destruction counter.
Should be called in the destructor of any derived class that will be reference counted.
Definition at line 194 of file reference_counter.h.
References _counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.
Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().
|
static |
Prints the number of outstanding (created, but not yet destroyed) objects.
Definition at line 83 of file reference_counter.h.
References _n_objects.
|
static |
Prints the reference information, by default to libMesh::out
.
|
staticprotected |
Actually holds the data.
Definition at line 122 of file reference_counter.h.
Referenced by increment_constructor_count(), and increment_destructor_count().
|
staticprotected |
Flag to control whether reference count information is printed when print_info is called.
Definition at line 141 of file reference_counter.h.
|
staticprotected |
Mutual exclusion object to enable thread-safe reference counting.
Definition at line 135 of file reference_counter.h.
|
staticprotected |
The number of objects.
Print the reference count information when the number returns to 0.
Definition at line 130 of file reference_counter.h.
Referenced by n_objects(), ReferenceCounter(), and ~ReferenceCounter().