libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change > Class Template Reference

We use a class to turn Threads::in_threads on and off, to be exception-safe. More...

#include <threads.h>

Public Member Functions
	RAIIAcquire (T &x, T new_x=new_x_default)
	~RAIIAcquire ()

Private Attributes
T &	_x
T	_old_x
T	_new_x

Detailed Description

template<typename T, T new_x_default = T(), bool assert_change = false>
class libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >

We use a class to turn Threads::in_threads on and off, to be exception-safe.

We'll use the same class to set Threads::active_threads, for the same reason, but it's a little more complicated for that.

Definition at line 65 of file threads.h.

Constructor & Destructor Documentation

RAIIAcquire()

template<typename T, T new_x_default = T(), bool assert_change = false>

libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::RAIIAcquire ( T &  x, T  new_x = new_x_default  )

inlineexplicit

Definition at line 69 of file threads.h.

References libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::_new_x, libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::_x, and libMesh::libmesh_assert().

                                              :
    _x(x), _old_x(x), _new_x(new_x)
  {
    libmesh_assert(!assert_change || _x != _new_x);
    _x = _new_x;
  }

~RAIIAcquire()

template<typename T, T new_x_default = T(), bool assert_change = false>

libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::~RAIIAcquire ( )

inline

Definition at line 76 of file threads.h.

References libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::_new_x, libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::_old_x, and libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::_x.

{ libmesh_exceptionless_assert(_x == _new_x); _x = _old_x; }

Member Data Documentation

_new_x

template<typename T, T new_x_default = T(), bool assert_change = false>

T libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::_new_x

private

Definition at line 80 of file threads.h.

Referenced by libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::RAIIAcquire(), and libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::~RAIIAcquire().

_old_x

template<typename T, T new_x_default = T(), bool assert_change = false>

T libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::_old_x

private

Definition at line 79 of file threads.h.

Referenced by libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::~RAIIAcquire().

_x

template<typename T, T new_x_default = T(), bool assert_change = false>

T& libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::_x

private

Definition at line 78 of file threads.h.

Referenced by libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::RAIIAcquire(), and libMesh::Threads::RAIIAcquire< T, new_x_default, assert_change >::~RAIIAcquire().

---

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

• include/parallel/threads.h