libMesh
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Attributes | List of all members
libMesh::ReferenceCounter Class Reference

This is the base class for enabling reference counting. More...

#include <reference_counter.h>

Inheritance diagram for libMesh::ReferenceCounter:
[legend]

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...
 

Detailed Description

This is the base class for enabling reference counting.

It should not be used by the user, thus it has a private constructor.

Author
Benjamin S. Kirk
Date
2002-2007 Common base for all objects whose creations/destructions are counted.

Definition at line 44 of file reference_counter.h.

Member Typedef Documentation

◆ Counts

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts
protected

Data structure to log the information.

The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

Constructor & Destructor Documentation

◆ ReferenceCounter() [1/3]

libMesh::ReferenceCounter::ReferenceCounter ( )
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.

149 {
150  ++_n_objects;
151 }
static Threads::atomic< unsigned int > _n_objects
The number of objects.

◆ ReferenceCounter() [2/3]

libMesh::ReferenceCounter::ReferenceCounter ( const ReferenceCounter )
protected

Definition at line 155 of file reference_counter.h.

References _n_objects.

156 {
157  ++_n_objects;
158 }
static Threads::atomic< unsigned int > _n_objects
The number of objects.

◆ ReferenceCounter() [3/3]

libMesh::ReferenceCounter::ReferenceCounter ( ReferenceCounter &&  other)
protectednoexcept

Move constructor, must be declared noexcept.

Definition at line 162 of file reference_counter.h.

References _n_objects.

163 {
164  ++_n_objects;
165 }
static Threads::atomic< unsigned int > _n_objects
The number of objects.

◆ ~ReferenceCounter()

libMesh::ReferenceCounter::~ReferenceCounter ( )

Destructor.

Definition at line 169 of file reference_counter.h.

References _n_objects.

170 {
171  --_n_objects;
172 }
static Threads::atomic< unsigned int > _n_objects
The number of objects.

Member Function Documentation

◆ disable_print_counter_info()

static void libMesh::ReferenceCounter::disable_print_counter_info ( )
static

◆ enable_print_counter_info()

static void libMesh::ReferenceCounter::enable_print_counter_info ( )
static

Methods to enable/disable the reference counter output from print_info()

◆ get_info()

static std::string libMesh::ReferenceCounter::get_info ( )
static

Gets a string containing the reference information.

◆ increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string &  name)
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().

182 {
183  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
184  std::pair<unsigned int, unsigned int> & p = _counts[name];
185 
186  p.first++;
187 }
std::string name(const ElemQuality q)
static Counts _counts
Actually holds the data.
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.

◆ increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string &  name)
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().

195 {
196  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
197  std::pair<unsigned int, unsigned int> & p = _counts[name];
198 
199  p.second++;
200 }
std::string name(const ElemQuality q)
static Counts _counts
Actually holds the data.
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.

◆ n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )
static

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 83 of file reference_counter.h.

References _n_objects.

84  { return _n_objects; }
static Threads::atomic< unsigned int > _n_objects
The number of objects.

◆ print_info()

static void libMesh::ReferenceCounter::print_info ( std::ostream &  out = libMesh::out)
static

Prints the reference information, by default to libMesh::out.

Member Data Documentation

◆ _counts

Counts libMesh::ReferenceCounter::_counts
staticprotected

Actually holds the data.

Definition at line 122 of file reference_counter.h.

Referenced by increment_constructor_count(), and increment_destructor_count().

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter
staticprotected

Flag to control whether reference count information is printed when print_info is called.

Definition at line 141 of file reference_counter.h.

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex
staticprotected

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_objects

Threads::atomic<unsigned int> libMesh::ReferenceCounter::_n_objects
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().


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