Public Member Functions | Private Attributes | List of all members
alvar::Lock Class Reference

Lock for simplifying mutex handling. More...

#include <Lock.h>

Inheritance diagram for alvar::Lock:
Inheritance graph
[legend]

Public Member Functions

 Lock (Mutex *mutex)
 Constructor. More...
 
 ~Lock ()
 Destructor. More...
 

Private Attributes

MutexmMutex
 

Additional Inherited Members

- Private Member Functions inherited from alvar::Uncopyable
 Uncopyable ()
 Constructor. More...
 
 ~Uncopyable ()
 Destructor. More...
 

Detailed Description

Lock for simplifying mutex handling.

Lock class for simplifying mutex handling. Simply pass a mutex to the constructor and the mutex will be locked. When the lock is destroyed, the mutex will be unlocked.

Definition at line 46 of file Lock.h.

Constructor & Destructor Documentation

alvar::Lock::Lock ( Mutex mutex)
inline

Constructor.

Parameters
mutexThe mutex to lock.

Definition at line 54 of file Lock.h.

alvar::Lock::~Lock ( )
inline

Destructor.

Definition at line 63 of file Lock.h.

Member Data Documentation

Mutex* alvar::Lock::mMutex
private

Definition at line 69 of file Lock.h.


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


ar_track_alvar
Author(s): Scott Niekum
autogenerated on Mon Jun 10 2019 12:47:04