\section{Basic\-Lockable Class Reference}
\label{class_basic_lockable}\index{BasicLockable@{BasicLockable}}
There are two basic methods of using this class.  


{\tt \#include $<$Basic\-Lockable.h$>$}

Inheritance diagram for Basic\-Lockable:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=60pt]{class_basic_lockable__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Basic\-Lockable} ()
\item 
{\bf $\sim$Basic\-Lockable} ()
\item 
void {\bf lock} ()
\begin{CompactList}\small\item\em Lock the mutex. \item\end{CompactList}\item 
void {\bf unlock} ()
\begin{CompactList}\small\item\em Unlock the mutex. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
pthread\_\-mutex\_\-t {\bf mutex}
\end{CompactItemize}


\subsection{Detailed Description}
There are two basic methods of using this class. 

\begin{enumerate}
\item A class can inherit from Basic\-Lockable. This alows code to lock on the inherited object itself.\item The user can create instances of Basic\-Lockable directly. \end{enumerate}




\subsection{Constructor \& Destructor Documentation}
\index{BasicLockable@{Basic\-Lockable}!BasicLockable@{BasicLockable}}
\index{BasicLockable@{BasicLockable}!BasicLockable@{Basic\-Lockable}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Basic\-Lockable::Basic\-Lockable ()}\label{class_basic_lockable_a0}


\index{BasicLockable@{Basic\-Lockable}!~BasicLockable@{$\sim$BasicLockable}}
\index{~BasicLockable@{$\sim$BasicLockable}!BasicLockable@{Basic\-Lockable}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Basic\-Lockable::$\sim${\bf Basic\-Lockable} ()}\label{class_basic_lockable_a1}




\subsection{Member Function Documentation}
\index{BasicLockable@{Basic\-Lockable}!lock@{lock}}
\index{lock@{lock}!BasicLockable@{Basic\-Lockable}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Basic\-Lockable::lock ()\hspace{0.3cm}{\tt  [inline]}}\label{class_basic_lockable_a2}


Lock the mutex. 

\index{BasicLockable@{Basic\-Lockable}!unlock@{unlock}}
\index{unlock@{unlock}!BasicLockable@{Basic\-Lockable}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Basic\-Lockable::unlock ()\hspace{0.3cm}{\tt  [inline]}}\label{class_basic_lockable_a3}


Unlock the mutex. 



\subsection{Member Data Documentation}
\index{BasicLockable@{Basic\-Lockable}!mutex@{mutex}}
\index{mutex@{mutex}!BasicLockable@{Basic\-Lockable}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}pthread\_\-mutex\_\-t {\bf Basic\-Lockable::mutex}\hspace{0.3cm}{\tt  [protected]}}\label{class_basic_lockable_p0}




The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
{\bf Basic\-Lockable.h}\item 
{\bf Basic\-Lockable.cpp}\end{CompactItemize}
