\hypertarget{classXrlParserInput}{
\section{XrlParserInput Class Reference}
\label{classXrlParserInput}\index{XrlParserInput@{XrlParserInput}}
}


Base class for XrlParserInput's.  




{\ttfamily \#include $<$xrl\_\-parser\_\-input.hh$>$}

Inheritance diagram for XrlParserInput:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classXrlParserInput}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual bool \hyperlink{classXrlParserInput_a5b392cfb43c66a20de4575f220bdfbab}{getline} (string \&lineout)=0
\begin{DoxyCompactList}\small\item\em Retrieves 1 line of input from source. \item\end{DoxyCompactList}\item 
virtual bool \hyperlink{classXrlParserInput_a64ca4db997cc739bffd929ecc0e04942}{eof} () const =0
\item 
virtual string \hyperlink{classXrlParserInput_ae6528810ea8c0cd6870ffa054f141faf}{stack\_\-trace} () const =0
\end{DoxyCompactItemize}


\subsection{Detailed Description}
Base class for XrlParserInput's. XrlParserInput's are used by \hyperlink{protocolthe-p}{the} \hyperlink{classXrlParser}{XrlParser} class to manage input. The output of \hyperlink{classXrlParserInput}{XrlParserInput} should only contain material likely to XRL's and C-\/preprocessor hash directives, ie \# $<$num$>$ \char`\"{}file\char`\"{} $<$line$>$ directives. 

\subsection{Member Function Documentation}
\hypertarget{classXrlParserInput_a64ca4db997cc739bffd929ecc0e04942}{
\index{XrlParserInput@{XrlParserInput}!eof@{eof}}
\index{eof@{eof}!XrlParserInput@{XrlParserInput}}
\subsubsection[{eof}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool XrlParserInput::eof (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classXrlParserInput_a64ca4db997cc739bffd929ecc0e04942}
\begin{DoxyReturn}{Returns}
true if no more data is available for reading. 
\end{DoxyReturn}


Implemented in \hyperlink{classXrlParserFileInput_ac301a6fb9fa8eabcc78b368f86719927}{XrlParserFileInput}.

\hypertarget{classXrlParserInput_a5b392cfb43c66a20de4575f220bdfbab}{
\index{XrlParserInput@{XrlParserInput}!getline@{getline}}
\index{getline@{getline}!XrlParserInput@{XrlParserInput}}
\subsubsection[{getline}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool XrlParserInput::getline (
\begin{DoxyParamCaption}
\item[{string \&}]{lineout}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classXrlParserInput_a5b392cfb43c66a20de4575f220bdfbab}


Retrieves 1 line of input from source. 


\begin{DoxyParams}{Parameters}
{\em lineout} & string that is set if line of text is available. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if line was read into lineout, false otherwise. 
\end{DoxyReturn}


Implemented in \hyperlink{classXrlParserFileInput_af4d45a773dec54272746660d67be00d6}{XrlParserFileInput}.

\hypertarget{classXrlParserInput_ae6528810ea8c0cd6870ffa054f141faf}{
\index{XrlParserInput@{XrlParserInput}!stack\_\-trace@{stack\_\-trace}}
\index{stack\_\-trace@{stack\_\-trace}!XrlParserInput@{XrlParserInput}}
\subsubsection[{stack\_\-trace}]{\setlength{\rightskip}{0pt plus 5cm}virtual string XrlParserInput::stack\_\-trace (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classXrlParserInput_ae6528810ea8c0cd6870ffa054f141faf}
\begin{DoxyReturn}{Returns}
string containing stack trace to be used for tracking errors in \hyperlink{protocolthe-p}{the} input. 
\end{DoxyReturn}


Implemented in \hyperlink{classXrlParserFileInput_a34c42fa4eb9234ad2dc6078ef31e5065}{XrlParserFileInput}.



The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item 
/home/greearb/git/xorp.ct.github/xorp/libxipc/xrl\_\-parser\_\-input.hh\end{DoxyCompactItemize}
