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 = true
 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

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 119 of file reference_counter.h.

Constructor & Destructor Documentation

libMesh::ReferenceCounter::ReferenceCounter ( )
protected

Constructors.

Protected so that you cannot instantiate a ReferenceCounter, only derive from it.

Definition at line 150 of file reference_counter.h.

References _n_objects.

151 {
152  ++_n_objects;
153 }
static Threads::atomic< unsigned int > _n_objects
The number of objects.
libMesh::ReferenceCounter::ReferenceCounter ( const ReferenceCounter )
protected

Definition at line 157 of file reference_counter.h.

References _n_objects.

158 {
159  ++_n_objects;
160 }
static Threads::atomic< unsigned int > _n_objects
The number of objects.
libMesh::ReferenceCounter::ReferenceCounter ( ReferenceCounter &&  other)
protectednoexcept

Move constructor, must be declared noexcept.

Definition at line 165 of file reference_counter.h.

References _n_objects.

166 {
167  ++_n_objects;
168 }
static Threads::atomic< unsigned int > _n_objects
The number of objects.
libMesh::ReferenceCounter::~ReferenceCounter ( )

Destructor.

Definition at line 173 of file reference_counter.h.

References _n_objects.

174 {
175  --_n_objects;
176 }
static Threads::atomic< unsigned int > _n_objects
The number of objects.

Member Function Documentation

void libMesh::ReferenceCounter::disable_print_counter_info ( )
static

Definition at line 107 of file reference_counter.C.

References _enable_print_counter.

Referenced by libMesh::LibMeshInit::LibMeshInit(), and n_objects().

108 {
109  _enable_print_counter = false;
110  return;
111 }
static bool _enable_print_counter
Flag to control whether reference count information is printed when print_info is called...
void libMesh::ReferenceCounter::enable_print_counter_info ( )
static

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

Definition at line 101 of file reference_counter.C.

References _enable_print_counter.

Referenced by n_objects().

102 {
103  _enable_print_counter = true;
104  return;
105 }
static bool _enable_print_counter
Flag to control whether reference count information is printed when print_info is called...
std::string libMesh::ReferenceCounter::get_info ( )
static

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

References _counts, and libMesh::Quality::name().

Referenced by print_info().

48 {
49 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
50 
51  std::ostringstream oss;
52 
53  oss << '\n'
54  << " ---------------------------------------------------------------------------- \n"
55  << "| Reference count information |\n"
56  << " ---------------------------------------------------------------------------- \n";
57 
58  for (Counts::iterator it = _counts.begin();
59  it != _counts.end(); ++it)
60  {
61  const std::string name(it->first);
62  const unsigned int creations = it->second.first;
63  const unsigned int destructions = it->second.second;
64 
65  oss << "| " << name << " reference count information:\n"
66  << "| Creations: " << creations << '\n'
67  << "| Destructions: " << destructions << '\n';
68  }
69 
70  oss << " ---------------------------------------------------------------------------- \n";
71 
72  return oss.str();
73 
74 #else
75 
76  return "";
77 
78 #endif
79 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:39
static Counts _counts
Actually holds the data.
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 185 of file reference_counter.h.

References _counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by n_objects(), and libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

186 {
187  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
188  std::pair<unsigned int, unsigned int> & p = _counts[name];
189 
190  p.first++;
191 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:39
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.
Definition: threads.C:29
static Counts _counts
Actually holds the data.
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 198 of file reference_counter.h.

References _counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by n_objects(), and libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

199 {
200  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
201  std::pair<unsigned int, unsigned int> & p = _counts[name];
202 
203  p.second++;
204 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:39
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.
Definition: threads.C:29
static Counts _counts
Actually holds the data.
static unsigned int libMesh::ReferenceCounter::n_objects ( )
static

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

Definition at line 85 of file reference_counter.h.

References _n_objects, disable_print_counter_info(), enable_print_counter_info(), increment_constructor_count(), increment_destructor_count(), int, and libMesh::Quality::name().

Referenced by libMesh::System::hide_output(), and libMesh::LibMeshInit::LibMeshInit().

86  { return _n_objects; }
static Threads::atomic< unsigned int > _n_objects
The number of objects.
void libMesh::ReferenceCounter::print_info ( std::ostream &  out = libMesh::out)
static

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

Definition at line 88 of file reference_counter.C.

References _enable_print_counter, and get_info().

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

89 {
91  out_stream << ReferenceCounter::get_info();
92 }
static std::string get_info()
Gets a string containing the reference information.
static bool _enable_print_counter
Flag to control whether reference count information is printed when print_info is called...

Member Data Documentation

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts
staticprotected

Actually holds the data.

Definition at line 124 of file reference_counter.h.

Referenced by get_info(), increment_constructor_count(), and increment_destructor_count().

bool libMesh::ReferenceCounter::_enable_print_counter = true
staticprotected

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

Definition at line 143 of file reference_counter.h.

Referenced by disable_print_counter_info(), enable_print_counter_info(), and print_info().

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

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 137 of file reference_counter.h.

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 132 of file reference_counter.h.

Referenced by n_objects(), ReferenceCounter(), and ~ReferenceCounter().


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