\hypertarget{expand_8h}{
\section{expand.h File Reference}
\label{expand_8h}\index{expand.h@{expand.h}}
}
Expansion routines. 

{\tt \#include $<$unistd.h$>$}\par
{\tt \#include $<$stdlib.h$>$}\par
{\tt \#include $<$stdio.h$>$}\par


Include dependency graph for expand.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=95pt]{expand_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=140pt]{expand_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{expand_8h_a0}{
typedef \hyperlink{structQSEC__expansion__}{QSEC\_\-expansion\_\-} \hyperlink{expand_8h_a0}{QSEC\_\-expansion}}
\label{expand_8h_a0}

\begin{CompactList}\small\item\em Declaration of the opaque expansion structure. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
void \hyperlink{expand_8h_a1}{QSEC\_\-clear\-Expansion} (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$exp)
\begin{CompactList}\small\item\em Clear away any context from a previous cycle. \item\end{CompactList}\item 
\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$ \hyperlink{expand_8h_a2}{QSEC\_\-construct\-Expansion} (void $\ast$buffer, unsigned cap)
\begin{CompactList}\small\item\em Construct a QSEC\_\-expansion structure in a buffer. \item\end{CompactList}\item 
void \hyperlink{expand_8h_a3}{QSEC\_\-delete\-Expansion} (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$exp)
\begin{CompactList}\small\item\em Free memory previously allocated with a call to QSEC\_\-new\-Expansion. \item\end{CompactList}\item 
unsigned \hyperlink{expand_8h_a4}{QSEC\_\-monitor\-Expansion} (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$exp, unsigned mon)
\begin{CompactList}\small\item\em Set the monitoring level for the expansion. \item\end{CompactList}\item 
\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$ \hyperlink{expand_8h_a5}{QSEC\_\-new\-Expansion} (unsigned cap)
\begin{CompactList}\small\item\em Allocate memory for a QSEC\_\-expansion structure and all the substructures. \item\end{CompactList}\item 
const unsigned int $\ast$ \hyperlink{expand_8h_a6}{QSEC\_\-recover\-User} (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$exp, const unsigned int $\ast$buf)
\begin{CompactList}\small\item\em Unpack the tables against which the events were encoded. \item\end{CompactList}\item 
void \hyperlink{expand_8h_a7}{QSEC\_\-report\-Expansion} (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$exp, FILE $\ast$fp)
\begin{CompactList}\small\item\em Report the contents of an expansion. \item\end{CompactList}\item 
void \hyperlink{expand_8h_a8}{QSEC\_\-set\-Four\-Range} (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$exp, unsigned rng)
\begin{CompactList}\small\item\em Set the range for a calibration expansion. \item\end{CompactList}\item 
void \hyperlink{expand_8h_a9}{QSEC\_\-set\-Mode} (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$exp, unsigned mode)
\begin{CompactList}\small\item\em Set the calibration mode of an expansion. \item\end{CompactList}\item 
size\_\-t \hyperlink{expand_8h_a10}{QSEC\_\-sizeof\-Expansion} (unsigned cap)
\begin{CompactList}\small\item\em Calculate the size of the memory block required to accomodate the expansion structure. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Expansion routines. 

\begin{Desc}
\item[Author:]James Swain \& Owen Saxton\end{Desc}
\begin{Desc}
\item[Id]\hyperlink{expand_8h}{expand.h},v 1.3 2007/04/05 22:59:31 saxton Exp \end{Desc}


\subsection{Function Documentation}
\hypertarget{expand_8h_a1}{
\index{expand.h@{expand.h}!QSEC_clearExpansion@{QSEC\_\-clearExpansion}}
\index{QSEC_clearExpansion@{QSEC\_\-clearExpansion}!expand.h@{expand.h}}
\subsubsection[QSEC\_\-clearExpansion]{\setlength{\rightskip}{0pt plus 5cm}void QSEC\_\-clear\-Expansion (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$ {\em exp})}}
\label{expand_8h_a1}


Clear away any context from a previous cycle. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em exp}]Pointer to a expansion object\end{description}
\end{Desc}
\hypertarget{expand_8h_a2}{
\index{expand.h@{expand.h}!QSEC_constructExpansion@{QSEC\_\-constructExpansion}}
\index{QSEC_constructExpansion@{QSEC\_\-constructExpansion}!expand.h@{expand.h}}
\subsubsection[QSEC\_\-constructExpansion]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion}$\ast$ QSEC\_\-construct\-Expansion (void $\ast$ {\em buffer}, unsigned {\em cap})}}
\label{expand_8h_a2}


Construct a QSEC\_\-expansion structure in a buffer. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cap}]Capacity of the decompression, maximum number of events in a single cycle\item[{\em buffer}]Uninitialised memory large enough to hold the expansion structure\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Pointer to an initialised expansion structure\end{Desc}
\hypertarget{expand_8h_a3}{
\index{expand.h@{expand.h}!QSEC_deleteExpansion@{QSEC\_\-deleteExpansion}}
\index{QSEC_deleteExpansion@{QSEC\_\-deleteExpansion}!expand.h@{expand.h}}
\subsubsection[QSEC\_\-deleteExpansion]{\setlength{\rightskip}{0pt plus 5cm}void QSEC\_\-delete\-Expansion (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$ {\em exp})}}
\label{expand_8h_a3}


Free memory previously allocated with a call to QSEC\_\-new\-Expansion. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em exp}]Pointer to a expansion structure previously created by a call to QSEC\_\-new\-Expansion\end{description}
\end{Desc}
\hypertarget{expand_8h_a4}{
\index{expand.h@{expand.h}!QSEC_monitorExpansion@{QSEC\_\-monitorExpansion}}
\index{QSEC_monitorExpansion@{QSEC\_\-monitorExpansion}!expand.h@{expand.h}}
\subsubsection[QSEC\_\-monitorExpansion]{\setlength{\rightskip}{0pt plus 5cm}unsigned QSEC\_\-monitor\-Expansion (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$ {\em exp}, unsigned {\em mon})}}
\label{expand_8h_a4}


Set the monitoring level for the expansion. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em exp}]Pointer to an initialised expansion\item[{\em mon}]Monitoring level\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Previous monitoring level\end{Desc}
\hypertarget{expand_8h_a5}{
\index{expand.h@{expand.h}!QSEC_newExpansion@{QSEC\_\-newExpansion}}
\index{QSEC_newExpansion@{QSEC\_\-newExpansion}!expand.h@{expand.h}}
\subsubsection[QSEC\_\-newExpansion]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion}$\ast$ QSEC\_\-new\-Expansion (unsigned {\em cap})}}
\label{expand_8h_a5}


Allocate memory for a QSEC\_\-expansion structure and all the substructures. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cap}]Capacity of the decompression, maximum number of events in a single cycle\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Pointer to an allocated, initialise, QSEC\_\-expansion structure\end{Desc}
\hypertarget{expand_8h_a6}{
\index{expand.h@{expand.h}!QSEC_recoverUser@{QSEC\_\-recoverUser}}
\index{QSEC_recoverUser@{QSEC\_\-recoverUser}!expand.h@{expand.h}}
\subsubsection[QSEC\_\-recoverUser]{\setlength{\rightskip}{0pt plus 5cm}const unsigned int$\ast$ QSEC\_\-recover\-User (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$ {\em exp}, const unsigned int $\ast$ {\em buf})}}
\label{expand_8h_a6}


Unpack the tables against which the events were encoded. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]Pointer to the buffer where the context is held\item[{\em exp}]Pointer to the structure containing the tables (an expansion)\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Pointer to the next input location to be read or NULL if there was an error during recovery of User data\end{Desc}
\hypertarget{expand_8h_a7}{
\index{expand.h@{expand.h}!QSEC_reportExpansion@{QSEC\_\-reportExpansion}}
\index{QSEC_reportExpansion@{QSEC\_\-reportExpansion}!expand.h@{expand.h}}
\subsubsection[QSEC\_\-reportExpansion]{\setlength{\rightskip}{0pt plus 5cm}void QSEC\_\-report\-Expansion (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$ {\em exp}, FILE $\ast$ {\em fp})}}
\label{expand_8h_a7}


Report the contents of an expansion. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em exp}]Pointer to a expansion object\item[{\em fp}]Pointer to the destination file\end{description}
\end{Desc}
\hypertarget{expand_8h_a8}{
\index{expand.h@{expand.h}!QSEC_setFourRange@{QSEC\_\-setFourRange}}
\index{QSEC_setFourRange@{QSEC\_\-setFourRange}!expand.h@{expand.h}}
\subsubsection[QSEC\_\-setFourRange]{\setlength{\rightskip}{0pt plus 5cm}void QSEC\_\-set\-Four\-Range (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$ {\em exp}, unsigned {\em rng})}}
\label{expand_8h_a8}


Set the range for a calibration expansion. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em exp}]Pointer to a expansion structure\item[{\em rng}]Flag indicating 4-range or auto-range\end{description}
\end{Desc}
\hypertarget{expand_8h_a9}{
\index{expand.h@{expand.h}!QSEC_setMode@{QSEC\_\-setMode}}
\index{QSEC_setMode@{QSEC\_\-setMode}!expand.h@{expand.h}}
\subsubsection[QSEC\_\-setMode]{\setlength{\rightskip}{0pt plus 5cm}void QSEC\_\-set\-Mode (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$ {\em exp}, unsigned {\em mode})}}
\label{expand_8h_a9}


Set the calibration mode of an expansion. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em exp}]Pointer to a expansion structure\item[{\em mode}]Type of calibration\end{description}
\end{Desc}
\hypertarget{expand_8h_a10}{
\index{expand.h@{expand.h}!QSEC_sizeofExpansion@{QSEC\_\-sizeofExpansion}}
\index{QSEC_sizeofExpansion@{QSEC\_\-sizeofExpansion}!expand.h@{expand.h}}
\subsubsection[QSEC\_\-sizeofExpansion]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t QSEC\_\-sizeof\-Expansion (unsigned {\em cap})}}
\label{expand_8h_a10}


Calculate the size of the memory block required to accomodate the expansion structure. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cap}]Capacity of the decompression, maximum number of events in a single cycle\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Size of the memory block required to accomodate the expansion structure\end{Desc}
