\hypertarget{dump_8h}{
\section{dump.h File Reference}
\label{dump_8h}\index{dump.h@{dump.h}}
}
Framework used to parse the contents of a stream of datagrams. 

{\tt \#include \char`\"{}QSE/CCSDS\_\-apid\-Dsc.h\char`\"{}}\par
{\tt \#include \char`\"{}QSE/QSE\_\-print\-Dvr.h\char`\"{}}\par
{\tt \#include $<$unistd.h$>$}\par


Include dependency graph for dump.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=131pt]{dump_8h__incl}
\end{center}
\end{figure}


This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=139pt]{dump_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{dump_8h_a0}{
typedef \hyperlink{struct__ApidStream}{\_\-Apid\-Stream} \hyperlink{dump_8h_a0}{Apid\-Stream}}
\label{dump_8h_a0}

\begin{CompactList}\small\item\em Typedef for struct \hyperlink{struct__ApidStream}{\_\-Apid\-Stream}. \item\end{CompactList}\item 
\hypertarget{dump_8h_a1}{
typedef LSF\_\-scan\-Contribution\-Handler( \hyperlink{dump_8h_a1}{DUMP\_\-dgm\-Handler} )(\hyperlink{struct__ApidStream}{Apid\-Stream} $\ast$, const LSF\_\-datagram $\ast$)}
\label{dump_8h_a1}

\begin{CompactList}\small\item\em Application specific datagram handler. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
size\_\-t \hyperlink{dump_8h_a2}{DUMP\_\-sizeof\-Astream} (void)
\begin{CompactList}\small\item\em Return the size of the Apid\-Stream structure. \item\end{CompactList}\item 
\hyperlink{struct__ApidStream}{Apid\-Stream} $\ast$ \hyperlink{dump_8h_a3}{DUMP\_\-construct\-Astream} (void $\ast$astream, unsigned int dgmid, unsigned short int apid, unsigned char $\ast$dsc\_\-buf, size\_\-t buf\_\-size, \hyperlink{dump_8h_a1}{DUMP\_\-dgm\-Handler} $\ast$dgm\_\-handler, void $\ast$rsrc)
\begin{CompactList}\small\item\em Construct an Apid\-Stream structure using the resources provided. \item\end{CompactList}\item 
void $\ast$ \hyperlink{dump_8h_a4}{DUMP\_\-get\-Resource} (\hyperlink{struct__ApidStream}{Apid\-Stream} $\ast$astream)
\begin{CompactList}\small\item\em Hand back the pointer to the application resources. \item\end{CompactList}\item 
int \hyperlink{dump_8h_a5}{DUMP\_\-process} (const char $\ast$file, int dmp\_\-ccsds)
\begin{CompactList}\small\item\em Process a file of physics events datagrams. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Framework used to parse the contents of a stream of datagrams. 

\begin{Desc}
\item[Author:]\href{mailto:jswain@slac.stanford.edu}{\tt jswain@slac.stanford.edu}\end{Desc}


\footnotesize\begin{verbatim}   Cvs $Id: dump.h,v 1.1.1.1 2006/05/03 18:15:32 jswain Exp $
\end{verbatim}
\normalsize


\subsection{Function Documentation}
\hypertarget{dump_8h_a3}{
\index{dump.h@{dump.h}!DUMP_constructAstream@{DUMP\_\-constructAstream}}
\index{DUMP_constructAstream@{DUMP\_\-constructAstream}!dump.h@{dump.h}}
\subsubsection[DUMP\_\-constructAstream]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{struct__ApidStream}{Apid\-Stream}$\ast$ DUMP\_\-construct\-Astream (void $\ast$ {\em astream}, unsigned int {\em dgmid}, unsigned short int {\em apid}, unsigned char $\ast$ {\em dsc\_\-buf}, size\_\-t {\em buf\_\-size}, \hyperlink{dump_8h_a1}{DUMP\_\-dgm\-Handler} $\ast$ {\em dgm\_\-handler}, void $\ast$ {\em rsrc})}}
\label{dump_8h_a3}


Construct an Apid\-Stream structure using the resources provided. 

\begin{Desc}
\item[Returns:]Pointer to the constructed Apid\-Stream structure\end{Desc}
\hypertarget{dump_8h_a4}{
\index{dump.h@{dump.h}!DUMP_getResource@{DUMP\_\-getResource}}
\index{DUMP_getResource@{DUMP\_\-getResource}!dump.h@{dump.h}}
\subsubsection[DUMP\_\-getResource]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ DUMP\_\-get\-Resource (\hyperlink{struct__ApidStream}{Apid\-Stream} $\ast$ {\em astream})}}
\label{dump_8h_a4}


Hand back the pointer to the application resources. 

\begin{Desc}
\item[Returns:]Pointer handed to DUMP when DUMP\_\-construct\-Astream was invoked \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em astream}]Pointer to the Apid\-Stream structure\end{description}
\end{Desc}
\hypertarget{dump_8h_a5}{
\index{dump.h@{dump.h}!DUMP_process@{DUMP\_\-process}}
\index{DUMP_process@{DUMP\_\-process}!dump.h@{dump.h}}
\subsubsection[DUMP\_\-process]{\setlength{\rightskip}{0pt plus 5cm}int DUMP\_\-process (const char $\ast$ {\em file}, int {\em dmp\_\-ccsds})}}
\label{dump_8h_a5}


Process a file of physics events datagrams. 

\begin{Desc}
\item[Returns:]Overall status\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em file}]Name of the file to process \item[{\em dmp\_\-ccsds}]Flag indicating whether (1) or not (0) to print out the raw CCSDS\end{description}
\end{Desc}
\hypertarget{dump_8h_a2}{
\index{dump.h@{dump.h}!DUMP_sizeofAstream@{DUMP\_\-sizeofAstream}}
\index{DUMP_sizeofAstream@{DUMP\_\-sizeofAstream}!dump.h@{dump.h}}
\subsubsection[DUMP\_\-sizeofAstream]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t DUMP\_\-sizeof\-Astream (void)}}
\label{dump_8h_a2}


Return the size of the Apid\-Stream structure. 

\begin{Desc}
\item[Returns:]Size of the Apid\-Stream structure\end{Desc}
