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/classSeqWindow.tex | 132 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 doc/latex/classSeqWindow.tex (limited to 'doc/latex/classSeqWindow.tex') diff --git a/doc/latex/classSeqWindow.tex b/doc/latex/classSeqWindow.tex new file mode 100644 index 0000000..574e860 --- /dev/null +++ b/doc/latex/classSeqWindow.tex @@ -0,0 +1,132 @@ +\section{Seq\-Window Class Reference} +\label{classSeqWindow}\index{SeqWindow@{SeqWindow}} +{\tt \#include $<$seq\-Window.h$>$} + +\subsection*{Public Types} +\begin{CompactItemize} +\item +typedef std::deque$<$ {\bf seq\_\-nr\_\-t} $>$ {\bf Seq\-Deque} +\item +typedef std::map$<$ {\bf sender\_\-id\_\-t}, {\bf Seq\-Deque} $>$ {\bf Sender\-Map} +\end{CompactItemize} +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +{\bf Seq\-Window} ({\bf window\_\-size\_\-t} w) +\item +{\bf $\sim$Seq\-Window} () +\item +Seq\-Deque::size\_\-type {\bf get\-Length} ({\bf sender\_\-id\_\-t} sender) +\item +bool {\bf has\-Seq\-Nr} ({\bf sender\_\-id\_\-t} sender, {\bf seq\_\-nr\_\-t} seq) +\item +void {\bf add\-Seq\-Nr} ({\bf sender\_\-id\_\-t} sender, {\bf seq\_\-nr\_\-t} seq) +\item +void {\bf clear} ({\bf sender\_\-id\_\-t} sender) +\item +void {\bf clear} () +\end{CompactItemize} +\subsection*{Private Member Functions} +\begin{CompactItemize} +\item +{\bf Seq\-Window} (const {\bf Seq\-Window} \&s) +\item +void {\bf operator=} (const {\bf Seq\-Window} \&s) +\end{CompactItemize} +\subsection*{Private Attributes} +\begin{CompactItemize} +\item +{\bf window\_\-size\_\-t} {\bf window\_\-size\_\-} +\item +{\bf Mutex} {\bf mutex\_\-} +\item +{\bf Sender\-Map} {\bf sender\_\-} +\end{CompactItemize} + + +\subsection{Member Typedef Documentation} +\index{SeqWindow@{Seq\-Window}!SeqDeque@{SeqDeque}} +\index{SeqDeque@{SeqDeque}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef std::deque$<${\bf seq\_\-nr\_\-t}$>$ {\bf Seq\-Window::Seq\-Deque}}\label{classSeqWindow_cf2d07003c8ca868146cffb4dd1d5ca7} + + +\index{SeqWindow@{Seq\-Window}!SenderMap@{SenderMap}} +\index{SenderMap@{SenderMap}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef std::map$<${\bf sender\_\-id\_\-t}, {\bf Seq\-Deque}$>$ {\bf Seq\-Window::Sender\-Map}}\label{classSeqWindow_127195f139c8d5d07ed93799c2d6821a} + + + + +\subsection{Constructor \& Destructor Documentation} +\index{SeqWindow@{Seq\-Window}!SeqWindow@{SeqWindow}} +\index{SeqWindow@{SeqWindow}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Seq\-Window::Seq\-Window ({\bf window\_\-size\_\-t} {\em w})}\label{classSeqWindow_8d513ab9ef2984ea93dad7e4026185c8} + + +\index{SeqWindow@{Seq\-Window}!~SeqWindow@{$\sim$SeqWindow}} +\index{~SeqWindow@{$\sim$SeqWindow}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Seq\-Window::$\sim$Seq\-Window ()}\label{classSeqWindow_d125bcc4751a746427f04dda7fd65a10} + + +\index{SeqWindow@{Seq\-Window}!SeqWindow@{SeqWindow}} +\index{SeqWindow@{SeqWindow}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Seq\-Window::Seq\-Window (const {\bf Seq\-Window} \& {\em s})\hspace{0.3cm}{\tt [private]}}\label{classSeqWindow_7a30b232f312d843b8d188cae01fef28} + + + + +\subsection{Member Function Documentation} +\index{SeqWindow@{Seq\-Window}!getLength@{getLength}} +\index{getLength@{getLength}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Seq\-Window::Seq\-Deque::size\_\-type Seq\-Window::get\-Length ({\bf sender\_\-id\_\-t} {\em sender})}\label{classSeqWindow_5d39959927c79c54d133ed77b297ad7c} + + +\index{SeqWindow@{Seq\-Window}!hasSeqNr@{hasSeqNr}} +\index{hasSeqNr@{hasSeqNr}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Seq\-Window::has\-Seq\-Nr ({\bf sender\_\-id\_\-t} {\em sender}, {\bf seq\_\-nr\_\-t} {\em seq})}\label{classSeqWindow_9e7714dda181863420c38975bd505aff} + + +\index{SeqWindow@{Seq\-Window}!addSeqNr@{addSeqNr}} +\index{addSeqNr@{addSeqNr}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Seq\-Window::add\-Seq\-Nr ({\bf sender\_\-id\_\-t} {\em sender}, {\bf seq\_\-nr\_\-t} {\em seq})}\label{classSeqWindow_255ca0fca3e701bd9e18d9fcb2c022a2} + + +\index{SeqWindow@{Seq\-Window}!clear@{clear}} +\index{clear@{clear}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Seq\-Window::clear ({\bf sender\_\-id\_\-t} {\em sender})}\label{classSeqWindow_e9774163b8f7ac0ec081d1ba5b2daed2} + + +\index{SeqWindow@{Seq\-Window}!clear@{clear}} +\index{clear@{clear}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Seq\-Window::clear ()}\label{classSeqWindow_b1a03fe152c7c94ff3f05005d595b424} + + +\index{SeqWindow@{Seq\-Window}!operator=@{operator=}} +\index{operator=@{operator=}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Seq\-Window::operator= (const {\bf Seq\-Window} \& {\em s})\hspace{0.3cm}{\tt [private]}}\label{classSeqWindow_37887e66297163fe301c77f2977a2a2b} + + + + +\subsection{Member Data Documentation} +\index{SeqWindow@{Seq\-Window}!window_size_@{window\_\-size\_\-}} +\index{window_size_@{window\_\-size\_\-}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf window\_\-size\_\-t} {\bf Seq\-Window::window\_\-size\_\-}\hspace{0.3cm}{\tt [private]}}\label{classSeqWindow_ef85ba28f8a655dc8c8d34aeddb8eea0} + + +\index{SeqWindow@{Seq\-Window}!mutex_@{mutex\_\-}} +\index{mutex_@{mutex\_\-}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Mutex} {\bf Seq\-Window::mutex\_\-}\hspace{0.3cm}{\tt [private]}}\label{classSeqWindow_87ec44a9a7398ecbcb92d90ba95b37a0} + + +\index{SeqWindow@{Seq\-Window}!sender_@{sender\_\-}} +\index{sender_@{sender\_\-}!SeqWindow@{Seq\-Window}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Sender\-Map} {\bf Seq\-Window::sender\_\-}\hspace{0.3cm}{\tt [private]}}\label{classSeqWindow_8bfc3742cacc75e9a72de13ff6ad98a2} + + + + +The documentation for this class was generated from the following files:\begin{CompactItemize} +\item +{\bf seq\-Window.h}\item +{\bf seq\-Window.cpp}\end{CompactItemize} -- cgit v1.2.3