Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Loki::ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 > Class Template Reference

Implementation class for a class per-instance member function with three parameters. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/external/loki/ScopeGuard.h>

Inheritance diagram for Loki::ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 >:
Loki::ScopeGuardImplBase

Public Member Functions

 ObjScopeGuardImpl3 (Obj &obj, MemFun memFun, P1 p1, P2 p2, P3 p3)
 
 ~ObjScopeGuardImpl3 () throw ()
 
void Execute ()
 
- Public Member Functions inherited from Loki::ScopeGuardImplBase
 ScopeGuardImplBase () throw ()
 
void Dismiss () const throw ()
 

Static Public Member Functions

static ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 > MakeObjGuard (Obj &obj, MemFun memFun, P1 p1, P2 p2, P3 p3)
 

Protected Attributes

MemFun memFun_
 
Obj & obj_
 
const P1 p1_
 
const P2 p2_
 
const P3 p3_
 
- Protected Attributes inherited from Loki::ScopeGuardImplBase
bool dismissed_
 

Additional Inherited Members

- Protected Member Functions inherited from Loki::ScopeGuardImplBase
 ScopeGuardImplBase (const ScopeGuardImplBase &other) throw ()
 Copy-constructor takes over responsibility from other ScopeGuard. More...
 
 ~ScopeGuardImplBase ()
 
- Static Protected Member Functions inherited from Loki::ScopeGuardImplBase
template<typename J >
static void SafeExecute (J &j) throw ()
 

Detailed Description

template<class Obj, typename MemFun, typename P1, typename P2, typename P3>
class Loki::ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 >

Implementation class for a class per-instance member function with three parameters.

Each parameter is copied by value - use Loki::ByRef if you must use a reference instead. ScopeGuard ignores any value returned from the call within the Execute function.

This class has 3 standalone helper functions which create a ScopeGuard. One is MakeObjGuard, which is deprecated but provided for older code. The other two are MakeGuard overloads, one which takes a pointer to an object, and the other which takes a reference.

Constructor & Destructor Documentation

template<class Obj, typename MemFun, typename P1, typename P2, typename P3>
Loki::ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 >::~ObjScopeGuardImpl3 ( )
throw (
)
inline
template<class Obj, typename MemFun, typename P1, typename P2, typename P3>
Loki::ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 >::ObjScopeGuardImpl3 ( Obj &  obj,
MemFun  memFun,
P1  p1,
P2  p2,
P3  p3 
)
inline

Member Function Documentation

template<class Obj, typename MemFun, typename P1, typename P2, typename P3>
void Loki::ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 >::Execute ( )
inline
template<class Obj, typename MemFun, typename P1, typename P2, typename P3>
static ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 > Loki::ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 >::MakeObjGuard ( Obj &  obj,
MemFun  memFun,
P1  p1,
P2  p2,
P3  p3 
)
inlinestatic

Member Data Documentation

template<class Obj, typename MemFun, typename P1, typename P2, typename P3>
MemFun Loki::ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 >::memFun_
protected
template<class Obj, typename MemFun, typename P1, typename P2, typename P3>
Obj& Loki::ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 >::obj_
protected
template<class Obj, typename MemFun, typename P1, typename P2, typename P3>
const P1 Loki::ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 >::p1_
protected
template<class Obj, typename MemFun, typename P1, typename P2, typename P3>
const P2 Loki::ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 >::p2_
protected
template<class Obj, typename MemFun, typename P1, typename P2, typename P3>
const P3 Loki::ObjScopeGuardImpl3< Obj, MemFun, P1, P2, P3 >::p3_
protected

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