ORCA: Optimization-based framework for Robotic Control Applications
Public Member Functions | Protected Attributes | List of all members
orca::common::MutexTryLock Class Reference

#include <Mutex.h>

+ Collaboration diagram for orca::common::MutexTryLock:

Public Member Functions

 MutexTryLock (MutexInterface &mutex)
 
bool isSuccessful ()
 
 ~MutexTryLock ()
 

Protected Attributes

MutexInterface_mutex
 

Constructor & Destructor Documentation

orca::common::MutexTryLock::MutexTryLock ( MutexInterface mutex)
inline

Try to lock a Mutex object

Parameters
mutexThe Mutex which should be attempted to be locked
orca::common::MutexTryLock::~MutexTryLock ( )
inline

Releases, if any, a lock on the previously try-locked Mutex

Member Function Documentation

bool orca::common::MutexTryLock::isSuccessful ( )
inline

Return if the locking of the Mutex was succesfull

Returns
true when the Mutex is locked

Member Data Documentation

MutexInterface& orca::common::MutexTryLock::_mutex
protected

The Mutex to lock and unlock


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