From 7763f07327f3abce839a690df46ced3bfd1d3d09 Mon Sep 17 00:00:00 2001 From: Erwin Nindl Date: Sun, 7 Oct 2007 22:07:03 +0000 Subject: added doxygen generatet documentation --- doc/latex/classCondition.tex | 73 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 doc/latex/classCondition.tex (limited to 'doc/latex/classCondition.tex') diff --git a/doc/latex/classCondition.tex b/doc/latex/classCondition.tex new file mode 100644 index 0000000..030bd66 --- /dev/null +++ b/doc/latex/classCondition.tex @@ -0,0 +1,73 @@ +\section{Condition Class Reference} +\label{classCondition}\index{Condition@{Condition}} +{\tt \#include $<$thread\-Utils.hpp$>$} + +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +{\bf Condition} () +\item +{\bf $\sim$Condition} () +\item +void {\bf wait} () +\item +void {\bf signal} () +\item +void {\bf broadcast} () +\end{CompactItemize} +\subsection*{Private Attributes} +\begin{CompactItemize} +\item +pthread\_\-cond\_\-t {\bf cond} +\item +{\bf Mutex} {\bf mutex} +\end{CompactItemize} + + +\subsection{Constructor \& Destructor Documentation} +\index{Condition@{Condition}!Condition@{Condition}} +\index{Condition@{Condition}!Condition@{Condition}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Condition::Condition ()\hspace{0.3cm}{\tt [inline]}}\label{classCondition_f11513db4fcbde93961fa0b65e7ab764} + + +\index{Condition@{Condition}!~Condition@{$\sim$Condition}} +\index{~Condition@{$\sim$Condition}!Condition@{Condition}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Condition::$\sim$Condition ()\hspace{0.3cm}{\tt [inline]}}\label{classCondition_b42f6d2dfb2d0de4bed4ed5032d4a8fc} + + + + +\subsection{Member Function Documentation} +\index{Condition@{Condition}!wait@{wait}} +\index{wait@{wait}!Condition@{Condition}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Condition::wait ()\hspace{0.3cm}{\tt [inline]}}\label{classCondition_0bb9ca22c3c755d0ed8c7483a857567a} + + +\index{Condition@{Condition}!signal@{signal}} +\index{signal@{signal}!Condition@{Condition}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Condition::signal ()\hspace{0.3cm}{\tt [inline]}}\label{classCondition_974c8fd419e6014028dc4147cc49ce56} + + +\index{Condition@{Condition}!broadcast@{broadcast}} +\index{broadcast@{broadcast}!Condition@{Condition}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Condition::broadcast ()\hspace{0.3cm}{\tt [inline]}}\label{classCondition_15d88ea71e837f967d13d805d675cc5b} + + + + +\subsection{Member Data Documentation} +\index{Condition@{Condition}!cond@{cond}} +\index{cond@{cond}!Condition@{Condition}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}pthread\_\-cond\_\-t {\bf Condition::cond}\hspace{0.3cm}{\tt [private]}}\label{classCondition_4c8982005641d63b696f671b28e3706d} + + +\index{Condition@{Condition}!mutex@{mutex}} +\index{mutex@{mutex}!Condition@{Condition}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Mutex} {\bf Condition::mutex}\hspace{0.3cm}{\tt [private]}}\label{classCondition_01622814c6a21250677c2b9cbfc86bfb} + + + + +The documentation for this class was generated from the following file:\begin{CompactItemize} +\item +{\bf thread\-Utils.hpp}\end{CompactItemize} -- cgit v1.2.3