\section{ost::Linked\-Double Class Reference}
\label{classost_1_1_linked_double}\index{ost::LinkedDouble@{ost::LinkedDouble}}
Self managed double linked list object chain.Accumulating double linked list.  


{\tt \#include $<$object.h$>$}

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
virtual {\bf Linked\-Double} $\ast$ {\bf get\-First} (void)
\begin{CompactList}\small\item\em Get first linked object in list. \item\end{CompactList}\item 
virtual {\bf Linked\-Double} $\ast$ {\bf get\-Last} (void)
\begin{CompactList}\small\item\em Gets the last object in the list. \item\end{CompactList}\item 
virtual {\bf Linked\-Double} $\ast$ {\bf get\-Insert} (void)
\begin{CompactList}\small\item\em Virtual to get the insert point to use when adding new members. \item\end{CompactList}\item 
{\bf Linked\-Double} $\ast$ {\bf get\-Next} (void)
\begin{CompactList}\small\item\em Get next object, for convenience. \item\end{CompactList}\item 
{\bf Linked\-Double} $\ast$ {\bf get\-Prev} (void)
\begin{CompactList}\small\item\em Get prev object in the list. \item\end{CompactList}\item 
void {\bf insert} ({\bf Linked\-Double} \&obj)
\begin{CompactList}\small\item\em Insert object into chain. \item\end{CompactList}\item 
void {\bf detach} (void)
\begin{CompactList}\small\item\em Remove object from chain. \item\end{CompactList}\item 
{\bf Linked\-Double} \& {\bf operator+=} ({\bf Linked\-Double} \&obj)
\item 
{\bf Linked\-Double} \& {\bf operator--} ()
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
{\bf Linked\-Double} ()
\item 
virtual {\bf $\sim$Linked\-Double} ()
\item 
virtual void {\bf enter\-Lock} (void)
\item 
virtual void {\bf leave\-Lock} (void)
\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
{\bf Linked\-Double} $\ast$ {\bf next\-Object}
\item 
{\bf Linked\-Double} $\ast$ {\bf prev\-Object}
\end{CompactItemize}


\subsection{Detailed Description}
Self managed double linked list object chain.Accumulating double linked list. 

This is used for accumulating lists by using as a base class for a derived subclass.

\begin{Desc}
\item[Author:]David Sugar $<${\tt dyfet@gnutelephony.org}$>$ \end{Desc}




\subsection{Constructor \& Destructor Documentation}
\index{ost::LinkedDouble@{ost::Linked\-Double}!LinkedDouble@{LinkedDouble}}
\index{LinkedDouble@{LinkedDouble}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Linked\-Double::Linked\-Double ()\hspace{0.3cm}{\tt  [inline, protected]}}\label{classost_1_1_linked_double_7b2b9952d67b924f5f194f9c01b6b45d}


\index{ost::LinkedDouble@{ost::Linked\-Double}!~LinkedDouble@{$\sim$LinkedDouble}}
\index{~LinkedDouble@{$\sim$LinkedDouble}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual ost::Linked\-Double::$\sim$Linked\-Double ()\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classost_1_1_linked_double_0ee7d59ed567a17c40b75a999f269f4d}




\subsection{Member Function Documentation}
\index{ost::LinkedDouble@{ost::Linked\-Double}!detach@{detach}}
\index{detach@{detach}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Linked\-Double::detach (void)}\label{classost_1_1_linked_double_0f592c7550dd8e514c73aec0b1a74e0d}


Remove object from chain. 

\index{ost::LinkedDouble@{ost::Linked\-Double}!enterLock@{enterLock}}
\index{enterLock@{enterLock}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void ost::Linked\-Double::enter\-Lock (void)\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classost_1_1_linked_double_e80ef685c53da73cd08a8a04a3789961}


\index{ost::LinkedDouble@{ost::Linked\-Double}!getFirst@{getFirst}}
\index{getFirst@{getFirst}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf Linked\-Double}$\ast$ ost::Linked\-Double::get\-First (void)\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_linked_double_4265554deed086d5df6ce8e4f48867de}


Get first linked object in list. 

This may be dynamically recast, and may refer to a master static bookmark pointer in a derived class. Otherwise it follows list to front.

\begin{Desc}
\item[Returns:]pointer to first object in list. \end{Desc}
\index{ost::LinkedDouble@{ost::Linked\-Double}!getInsert@{getInsert}}
\index{getInsert@{getInsert}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf Linked\-Double}$\ast$ ost::Linked\-Double::get\-Insert (void)\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_linked_double_db4bd830df95500ee4864a37f8daf2c5}


Virtual to get the insert point to use when adding new members. 

This may be current, or always head or always tail. As a virtual, this allows derived class to establish \char`\"{}policy\char`\"{}.

\begin{Desc}
\item[Returns:]pointer to insertion point in list. \end{Desc}
\index{ost::LinkedDouble@{ost::Linked\-Double}!getLast@{getLast}}
\index{getLast@{getLast}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf Linked\-Double}$\ast$ ost::Linked\-Double::get\-Last (void)\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_linked_double_50cdd92a38c931d8c8f1fa885134f500}


Gets the last object in the list. 

This normally follows the links to the end. This is a virtual because derived class may include a static member bookmark for the current end.

\begin{Desc}
\item[Returns:]pointer to last object in list. \end{Desc}
\index{ost::LinkedDouble@{ost::Linked\-Double}!getNext@{getNext}}
\index{getNext@{getNext}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Linked\-Double}$\ast$ ost::Linked\-Double::get\-Next (void)\hspace{0.3cm}{\tt  [inline]}}\label{classost_1_1_linked_double_ef019ef8ce1f8fde9ea0263251450b61}


Get next object, for convenience. 

Derived class may use this with a dynamic cast.

\begin{Desc}
\item[Returns:]next object in list. \end{Desc}
\index{ost::LinkedDouble@{ost::Linked\-Double}!getPrev@{getPrev}}
\index{getPrev@{getPrev}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Linked\-Double}$\ast$ ost::Linked\-Double::get\-Prev (void)\hspace{0.3cm}{\tt  [inline]}}\label{classost_1_1_linked_double_6764fe49871de47bcf4b88e993a5638c}


Get prev object in the list. 

\begin{Desc}
\item[Returns:]pointer to previous object. \end{Desc}
\index{ost::LinkedDouble@{ost::Linked\-Double}!insert@{insert}}
\index{insert@{insert}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Linked\-Double::insert ({\bf Linked\-Double} \& {\em obj})}\label{classost_1_1_linked_double_1599e6a312b4905991e9589432c824b3}


Insert object into chain. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em object}]being inserted. \end{description}
\end{Desc}
\index{ost::LinkedDouble@{ost::Linked\-Double}!leaveLock@{leaveLock}}
\index{leaveLock@{leaveLock}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void ost::Linked\-Double::leave\-Lock (void)\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classost_1_1_linked_double_a3c77c647276c0e51ae69b7500c6c67a}


\index{ost::LinkedDouble@{ost::Linked\-Double}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Linked\-Double}\& ost::Linked\-Double::operator+= ({\bf Linked\-Double} \& {\em obj})}\label{classost_1_1_linked_double_6fc539900d18fbc05ab25cabe827c041}


\index{ost::LinkedDouble@{ost::Linked\-Double}!operator--@{operator--}}
\index{operator--@{operator--}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Linked\-Double}\& ost::Linked\-Double::operator-- ()}\label{classost_1_1_linked_double_d2c1be56326c836bc0456b3de8fb0417}




\subsection{Member Data Documentation}
\index{ost::LinkedDouble@{ost::Linked\-Double}!nextObject@{nextObject}}
\index{nextObject@{nextObject}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Linked\-Double}$\ast$ {\bf ost::Linked\-Double::next\-Object}\hspace{0.3cm}{\tt  [protected]}}\label{classost_1_1_linked_double_8f55ab75b85c4275c81933780be208d0}


\index{ost::LinkedDouble@{ost::Linked\-Double}!prevObject@{prevObject}}
\index{prevObject@{prevObject}!ost::LinkedDouble@{ost::Linked\-Double}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Linked\-Double} $\ast$ {\bf ost::Linked\-Double::prev\-Object}\hspace{0.3cm}{\tt  [protected]}}\label{classost_1_1_linked_double_bc240a6e018ad73d3612edb0a42b0602}




The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
{\bf object.h}\end{CompactItemize}