\section{Basic\-Condition Class Reference}
\label{class_basic_condition}\index{BasicCondition@{BasicCondition}}
There are two basic methods of using this class.  


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

Inheritance diagram for Basic\-Condition:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=60pt]{class_basic_condition__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for Basic\-Condition:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=60pt]{class_basic_condition__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Basic\-Condition} ()
\item 
{\bf $\sim$Basic\-Condition} ()
\item 
void {\bf wait} ()
\begin{CompactList}\small\item\em Wait for a signal indefinately. \item\end{CompactList}\item 
bool {\bf timed\-Wait} (int msec)
\begin{CompactList}\small\item\em Wait for a signal no longer than msec milliseconds. \item\end{CompactList}\item 
void {\bf signal} ()
\begin{CompactList}\small\item\em Signal one waiting process. \item\end{CompactList}\item 
void {\bf broadcast} ()
\begin{CompactList}\small\item\em Signal all waiting processes. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item 
pthread\_\-cond\_\-t {\bf cond}
\end{CompactItemize}


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

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




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


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




\subsection{Member Function Documentation}
\index{BasicCondition@{Basic\-Condition}!broadcast@{broadcast}}
\index{broadcast@{broadcast}!BasicCondition@{Basic\-Condition}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Basic\-Condition::broadcast ()\hspace{0.3cm}{\tt  [inline]}}\label{class_basic_condition_a5}


Signal all waiting processes. 

\index{BasicCondition@{Basic\-Condition}!signal@{signal}}
\index{signal@{signal}!BasicCondition@{Basic\-Condition}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Basic\-Condition::signal ()\hspace{0.3cm}{\tt  [inline]}}\label{class_basic_condition_a4}


Signal one waiting process. 

\index{BasicCondition@{Basic\-Condition}!timedWait@{timedWait}}
\index{timedWait@{timedWait}!BasicCondition@{Basic\-Condition}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Basic\-Condition::timed\-Wait (int {\em msec})}\label{class_basic_condition_a3}


Wait for a signal no longer than msec milliseconds. 

This usefull if you cannot always guarantee a signal will come.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em msec}]Timeout in milliseconds\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]true if signaled, false if timedout or an error occured. \end{Desc}
\index{BasicCondition@{Basic\-Condition}!wait@{wait}}
\index{wait@{wait}!BasicCondition@{Basic\-Condition}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Basic\-Condition::wait ()\hspace{0.3cm}{\tt  [inline]}}\label{class_basic_condition_a2}


Wait for a signal indefinately. 



\subsection{Member Data Documentation}
\index{BasicCondition@{Basic\-Condition}!cond@{cond}}
\index{cond@{cond}!BasicCondition@{Basic\-Condition}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}pthread\_\-cond\_\-t {\bf Basic\-Condition::cond}\hspace{0.3cm}{\tt  [private]}}\label{class_basic_condition_r0}




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