\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`\"{}LSF/LSF\_\-scan.h\char`\"{}}\par
{\tt \#include $<$stdlib.h$>$}\par


Include dependency graph for dump.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=113pt]{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 APID stream structure typedef. \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$stream, const LSF\_\-datagram $\ast$dgm)}
\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 
\hypertarget{dump_8h_a3}{
\hyperlink{struct__ApidStream}{Apid\-Stream} $\ast$ {\bf DUMP\_\-construct\-Astream} (void $\ast$astream, unsigned dgmid, unsigned short apid, unsigned char $\ast$dsc\_\-buf, size\_\-t buf\_\-size, \hyperlink{dump_8h_a1}{DUMP\_\-dgm\-Handler} $\ast$dgm\_\-handler, void $\ast$rsrc)}
\label{dump_8h_a3}

\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 science datagrams. \item\end{CompactList}\end{CompactItemize}


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

\begin{Desc}
\item[Author:]James Swain \& Owen Saxton\end{Desc}
\begin{Desc}
\item[Id]\hyperlink{dump_8h}{dump.h},v 1.2 2007/10/26 21:46:35 saxton Exp \end{Desc}


\subsection{Function Documentation}
\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[Parameters:]
\begin{description}
\item[{\em astream}]Pointer to the Apid\-Stream structure\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Pointer handed to DUMP when DUMP\_\-construct\-Astream was invoked\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 science datagrams. 

\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}
\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em 0}]Success \item[{\em $\sim$0}]Failure\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}