Sophie

Sophie

distrib > Mandriva > 2007.0 > i586 > by-pkgid > ad1ba1135a9c9eeffc2e538163e00373 > files > 695

libCommonC++2_1.4-devel-1.4.1-1mdv2007.0.i586.rpm

\section{ost::Linked\-Single Class Reference}
\label{classost_1_1_linked_single}\index{ost::LinkedSingle@{ost::LinkedSingle}}
Self managed single linked list object chain.Accumulating single linked list.  


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

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
virtual {\bf Linked\-Single} $\ast$ {\bf get\-First} (void)
\begin{CompactList}\small\item\em Get first linked object in list. \item\end{CompactList}\item 
virtual {\bf Linked\-Single} $\ast$ {\bf get\-Last} (void)
\begin{CompactList}\small\item\em Gets the last object in the list. \item\end{CompactList}\item 
{\bf Linked\-Single} $\ast$ {\bf get\-Next} (void)
\begin{CompactList}\small\item\em Get next object, for convenience. \item\end{CompactList}\item 
virtual void {\bf insert} ({\bf Linked\-Single} \&obj)
\begin{CompactList}\small\item\em Insert object into chain. \item\end{CompactList}\item 
{\bf Linked\-Single} \& {\bf operator+=} ({\bf Linked\-Single} \&obj)
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
{\bf Linked\-Single} ()
\item 
virtual {\bf $\sim$Linked\-Single} ()
\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
{\bf Linked\-Single} $\ast$ {\bf next\-Object}
\end{CompactItemize}


\subsection{Detailed Description}
Self managed single linked list object chain.Accumulating single 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::LinkedSingle@{ost::Linked\-Single}!LinkedSingle@{LinkedSingle}}
\index{LinkedSingle@{LinkedSingle}!ost::LinkedSingle@{ost::Linked\-Single}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Linked\-Single::Linked\-Single ()\hspace{0.3cm}{\tt  [inline, protected]}}\label{classost_1_1_linked_single_61f80761bc11c58afaeab3c6b5fb0ca8}


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




\subsection{Member Function Documentation}
\index{ost::LinkedSingle@{ost::Linked\-Single}!getFirst@{getFirst}}
\index{getFirst@{getFirst}!ost::LinkedSingle@{ost::Linked\-Single}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf Linked\-Single}$\ast$ ost::Linked\-Single::get\-First (void)\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_linked_single_4974c1248c6225cc5f7f6e0ca84590d6}


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 simply returns the current object. In a \char`\"{}free\char`\"{} list, this may not only return the first object, but also set the first to next.

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


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::LinkedSingle@{ost::Linked\-Single}!getNext@{getNext}}
\index{getNext@{getNext}!ost::LinkedSingle@{ost::Linked\-Single}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Linked\-Single}$\ast$ ost::Linked\-Single::get\-Next (void)\hspace{0.3cm}{\tt  [inline]}}\label{classost_1_1_linked_single_4b8a6fc0cdb5dfc17a3180d616a7da08}


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::LinkedSingle@{ost::Linked\-Single}!insert@{insert}}
\index{insert@{insert}!ost::LinkedSingle@{ost::Linked\-Single}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void ost::Linked\-Single::insert ({\bf Linked\-Single} \& {\em obj})\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_linked_single_00b7d9a117394055260402a3baf0b9a1}


Insert object into chain. 

This is a virtual because derived class may choose instead to perform an insert at head or tail, may manage bookmarks, and may add mutex lock.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em object}]being inserted. \end{description}
\end{Desc}
\index{ost::LinkedSingle@{ost::Linked\-Single}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::LinkedSingle@{ost::Linked\-Single}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Linked\-Single}\& ost::Linked\-Single::operator+= ({\bf Linked\-Single} \& {\em obj})}\label{classost_1_1_linked_single_4acd01bea04106a4b7013c1f2caa2e65}




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




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