Sophie

Sophie

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

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

\section{ost::Stack\-Pager Class Reference}
\label{classost_1_1_stack_pager}\index{ost::StackPager@{ost::StackPager}}
The {\bf Stack\-Pager}{\rm (p.\,\pageref{classost_1_1_stack_pager})} provides a repository to stash and retrieve working data in last-in-first-out order.last in first out object pager.  


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

Inheritance diagram for ost::Stack\-Pager::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classost_1_1_stack_pager}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Stack\-Pager} (size\_\-t pagesize)
\begin{CompactList}\small\item\em Create a lifo pager as a mempager. \item\end{CompactList}\item 
void $\ast$ {\bf push} (const void $\ast$object, size\_\-t size)
\begin{CompactList}\small\item\em Push an arbitrary object onto the stack. \item\end{CompactList}\item 
void $\ast$ {\bf push} (const char $\ast$string)
\begin{CompactList}\small\item\em Push a string onto the stack. \item\end{CompactList}\item 
void $\ast$ {\bf pull} (void)
\begin{CompactList}\small\item\em Retrieve next object from stack. \item\end{CompactList}\item 
void {\bf purge} (void)
\begin{CompactList}\small\item\em Purge the stack of all objects and memory allocations. \item\end{CompactList}\end{CompactItemize}
\subsection*{Classes}
\begin{CompactItemize}
\item 
struct {\bf frame}
\end{CompactItemize}


\subsection{Detailed Description}
The {\bf Stack\-Pager}{\rm (p.\,\pageref{classost_1_1_stack_pager})} provides a repository to stash and retrieve working data in last-in-first-out order.last in first out object pager. 

The use of a mempager to support it's operation allows storage of arbitrary sized objects with no fixed limit.

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




\subsection{Constructor \& Destructor Documentation}
\index{ost::StackPager@{ost::Stack\-Pager}!StackPager@{StackPager}}
\index{StackPager@{StackPager}!ost::StackPager@{ost::Stack\-Pager}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Stack\-Pager::Stack\-Pager (size\_\-t {\em pagesize})}\label{classost_1_1_stack_pager_9082f804e418179370e78a9d29da39e5}


Create a lifo pager as a mempager. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em pagesize}]for memory allocation \end{description}
\end{Desc}


\subsection{Member Function Documentation}
\index{ost::StackPager@{ost::Stack\-Pager}!pull@{pull}}
\index{pull@{pull}!ost::StackPager@{ost::Stack\-Pager}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ ost::Stack\-Pager::pull (void)}\label{classost_1_1_stack_pager_4b840ef28c1c408d69d9b04729cd44a0}


Retrieve next object from stack. 

\begin{Desc}
\item[Returns:]object. \end{Desc}
\index{ost::StackPager@{ost::Stack\-Pager}!purge@{purge}}
\index{purge@{purge}!ost::StackPager@{ost::Stack\-Pager}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Stack\-Pager::purge (void)}\label{classost_1_1_stack_pager_c903c181770651ee8f42717892dd9fa4}


Purge the stack of all objects and memory allocations. 



Reimplemented from {\bf ost::Mem\-Pager} {\rm (p.\,\pageref{classost_1_1_mem_pager_5bfdb6f2d6f569ba08c32c59efb3a012})}.\index{ost::StackPager@{ost::Stack\-Pager}!push@{push}}
\index{push@{push}!ost::StackPager@{ost::Stack\-Pager}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ ost::Stack\-Pager::push (const char $\ast$ {\em string})}\label{classost_1_1_stack_pager_e8993b8e8287ceeb1e9fe46f8e3670c6}


Push a string onto the stack. 

\begin{Desc}
\item[Returns:]stack memory location. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em string}]pointer. \end{description}
\end{Desc}
\index{ost::StackPager@{ost::Stack\-Pager}!push@{push}}
\index{push@{push}!ost::StackPager@{ost::Stack\-Pager}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ ost::Stack\-Pager::push (const void $\ast$ {\em object}, size\_\-t {\em size})}\label{classost_1_1_stack_pager_89f60f5bb478d10354268a06f1441778}


Push an arbitrary object onto the stack. 

\begin{Desc}
\item[Returns:]stack memory location. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em object}]pointer to data \item[{\em size}]of data. \end{description}
\end{Desc}


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