lsst::ap::ScopeGuard Class Reference

Utility class for automatically invoking a function when leaving a scope. More...

#include <ScopeGuard.h>

Inheritance diagram for lsst::ap::ScopeGuard:

Public Types
typedef boost::function< void()>	Base

Public Member Functions
template<typename F >
	ScopeGuard (F const &f)
	~ScopeGuard ()
bool	dismissed () const throw ()
void	dismiss () throw ()

Private Attributes
bool	_dismissed

Static Private Attributes
static int volatile	_numGuards = 0

Detailed Description

Utility class for automatically invoking a function when leaving a scope.

See http://www.ddj.com/cpp/184403758 and http://www.zete.org/people/jlehrer/scopeguard.html for details on the origins and uses of this class.

Definition at line 51 of file ScopeGuard.h.

Member Typedef Documentation

typedef boost::function<void ()> lsst::ap::ScopeGuard::Base

Definition at line 55 of file ScopeGuard.h.

Constructor & Destructor Documentation

template<typename F >

lsst::ap::ScopeGuard::ScopeGuard ( F const &  f )

inlineexplicit

Definition at line 58 of file ScopeGuard.h.

                                     : Base(f), _dismissed(false) {
        ++_numGuards; // stop compiler from optimizing away entire object instances
    }

lsst::ap::ScopeGuard::~ScopeGuard ( )

inline

Definition at line 62 of file ScopeGuard.h.

                  {
        --_numGuards;
        try {
            if (!_dismissed) {
                operator()();
            }
        } catch (...) {}
    }

Member Function Documentation

void lsst::ap::ScopeGuard::dismiss ( ) throw ( )

inline

Definition at line 74 of file ScopeGuard.h.

                           {
        _dismissed = true;
    }

bool lsst::ap::ScopeGuard::dismissed ( ) const throw ( )

inline

Definition at line 71 of file ScopeGuard.h.

                                   {
        return _dismissed;
    }

Member Data Documentation

bool lsst::ap::ScopeGuard::_dismissed

private

Definition at line 80 of file ScopeGuard.h.

int volatile lsst::ap::ScopeGuard::_numGuards = 0

staticprivate

Definition at line 82 of file ScopeGuard.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/include/lsst/ap/ScopeGuard.h
• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/src/ScopeGuard.cc