OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Attributes | Friends | List of all members
openjaus::system::ScopeLock Class Reference

#include <ScopeLock.h>

Public Member Functions

 ScopeLock ()
 
virtual ~ScopeLock ()
 
 ScopeLock (Mutex &newMutex)
 
MutexgetMutex () const
 Accessor to get the value of mutex. More...
 
bool setMutex (Mutex *mutex)
 Accessor to set value of mutex. More...
 
virtual std::string toString () const
 

Protected Attributes

Mutexmutex
 

Friends

OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const ScopeLock &object)
 
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const ScopeLock *object)
 

Constructor & Destructor Documentation

§ ScopeLock() [1/2]

openjaus::system::ScopeLock::ScopeLock ( )

§ ~ScopeLock()

openjaus::system::ScopeLock::~ScopeLock ( )
virtual

§ ScopeLock() [2/2]

openjaus::system::ScopeLock::ScopeLock ( Mutex newMutex)

Member Function Documentation

§ getMutex()

Mutex * openjaus::system::ScopeLock::getMutex ( ) const

§ setMutex()

bool openjaus::system::ScopeLock::setMutex ( Mutex mutex)
Parameters
mutexThe value of the new mutex.

§ toString()

std::string openjaus::system::ScopeLock::toString ( ) const
virtual

Friends And Related Function Documentation

§ operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const ScopeLock object 
)
friend

§ operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const ScopeLock object 
)
friend

Member Data Documentation

§ mutex

Mutex* openjaus::system::ScopeLock::mutex
protected

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