lobot::AutoReadLock Class Reference

Read locks created on the stack that acquire an "underlying" read/write lock for reading on initialization and release it when the object goes out of scope. More...

#include <Robots/LoBot/thread/LoRWLock.H>

Collaboration diagram for lobot::AutoReadLock:

[legend]

List of all members.

Public Member Functions
	AutoReadLock (RWLock &)
	Constructor: will acquire the underlying lock object for reading.
	AutoReadLock (const RWLock &)
	~AutoReadLock ()
	Clean-up: will release the underlying lock object.

---

Detailed Description

Read locks created on the stack that acquire an "underlying" read/write lock for reading on initialization and release it when the object goes out of scope.

Definition at line 99 of file LoRWLock.H.

---

Constructor & Destructor Documentation

lobot::AutoReadLock::AutoReadLock

(

RWLock &

L

)

Constructor: will acquire the underlying lock object for reading.

Definition at line 116 of file LoRWLock.C.

References lobot::RWLock::begin_read().

lobot::AutoReadLock::AutoReadLock

(

const RWLock &

L

)

Constructor for const RWLock objects (e.g., when called from const member functions in client classes).

Definition at line 122 of file LoRWLock.C.

References lobot::RWLock::begin_read().

lobot::AutoReadLock::~AutoReadLock

(

)

Clean-up: will release the underlying lock object.

Definition at line 171 of file LoRWLock.C.

---

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

• src/Robots/LoBot/thread/LoRWLock.H
• src/Robots/LoBot/thread/LoRWLock.C