\hypertarget{CDFP_8c}{
\section{CDFP.c File Reference}
\label{CDFP_8c}\index{CDFP.c@{CDFP.c}}
}
Generic compression routines. 

{\tt \#include \char`\"{}LSEP/LSEP\_\-ids.h\char`\"{}}\par
{\tt \#include \char`\"{}CDFP.h\char`\"{}}\par
{\tt \#include \char`\"{}CDFP\_\-def.h\char`\"{}}\par
{\tt \#include \char`\"{}LSE/CDF\_\-esb.h\char`\"{}}\par
{\tt \#include \char`\"{}LSE/CDF\_\-gem.h\char`\"{}}\par
{\tt \#include \char`\"{}LSE/CDF\_\-acd.h\char`\"{}}\par
{\tt \#include \char`\"{}LSE/CDF\_\-cal.h\char`\"{}}\par
{\tt \#include \char`\"{}LSE/CDF\_\-tkr.h\char`\"{}}\par
{\tt \#include \char`\"{}LSE/CDF\_\-dgn.h\char`\"{}}\par
{\tt \#include \char`\"{}LSE/CDF\_\-err.h\char`\"{}}\par
{\tt \#include \char`\"{}LDT/HDE.h\char`\"{}}\par
{\tt \#include $<$string.h$>$}\par


Include dependency graph for CDFP.c:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=347pt]{CDFP_8c__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
static \_\-\_\-inline unsigned int $\ast$ \hyperlink{CDFP_8c_a0}{compose\-Ctb} (\hyperlink{struct__CDFP__ctxCtb}{CDFP\_\-ctx\-Ctb} $\ast$ctb, const \hyperlink{struct__CDFP__ctx}{CDFP\_\-ctx} $\ast$cdfp)
\begin{CompactList}\small\item\em Composes the CDF LSF contribution. \item\end{CompactList}\item 
int \hyperlink{CDFP_8c_a1}{CDFP\_\-sizeof} (int level, void $\ast$cfg)
\begin{CompactList}\small\item\em Returns the size, in bytes, of the compression structure needed to supprot the specified compression level. \item\end{CompactList}\item 
int \hyperlink{CDFP_8c_a2}{CDFP\_\-construct} (\hyperlink{struct__CDFP__ctx}{CDFP\_\-ctx} $\ast$cdfp, int level, void $\ast$cfg, LSEW\_\-dgm\-Fw $\ast$dgm\-Fw, \hyperlink{struct__LSEPW}{LSEPW} $\ast$lsepw)
\begin{CompactList}\small\item\em Constructs (initializes) the compression structure for the appropriate level. \item\end{CompactList}\item 
unsigned int $\ast$ \hyperlink{CDFP_8c_a3}{CDFP\_\-begin\_\-add} (\hyperlink{struct__CDFP__ctx}{CDFP\_\-ctx} $\ast$cdfp, unsigned int $\ast$beg, unsigned int len32)
\begin{CompactList}\small\item\em Begin datagram callback routine. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Generic compression routines. 

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


\footnotesize\begin{verbatim}   CVS $Id: CDFP.c,v 1.2 2006/11/08 19:01:46 russell Exp $
\end{verbatim}
\normalsize


\subsection{Function Documentation}
\hypertarget{CDFP_8c_a3}{
\index{CDFP.c@{CDFP.c}!CDFP_begin_add@{CDFP\_\-begin\_\-add}}
\index{CDFP_begin_add@{CDFP\_\-begin\_\-add}!CDFP.c@{CDFP.c}}
\subsubsection[CDFP\_\-begin\_\-add]{\setlength{\rightskip}{0pt plus 5cm}unsigned int$\ast$ CDFP\_\-begin\_\-add (\hyperlink{struct__CDFP__ctx}{CDFP\_\-ctx} $\ast$ {\em cdfp}, unsigned int $\ast$ {\em beg}, unsigned int {\em len32})}}
\label{CDFP_8c_a3}


Begin datagram callback routine. 

\begin{Desc}
\item[Returns:]Pointer to the next write location\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cdfp}]The Compressed Data Format handle \item[{\em beg}]The output buffer \item[{\em len32}]The amount of space, in 32-bit words, available in the output buffer\end{description}
\end{Desc}
\hypertarget{CDFP_8c_a2}{
\index{CDFP.c@{CDFP.c}!CDFP_construct@{CDFP\_\-construct}}
\index{CDFP_construct@{CDFP\_\-construct}!CDFP.c@{CDFP.c}}
\subsubsection[CDFP\_\-construct]{\setlength{\rightskip}{0pt plus 5cm}int CDFP\_\-construct (\hyperlink{struct__CDFP__ctx}{CDFP\_\-ctx} $\ast$ {\em cdfp}, int {\em level}, void $\ast$ {\em cfg}, LSEW\_\-dgm\-Fw $\ast$ {\em dgm\-Fw}, \hyperlink{struct__LSEPW}{LSEPW} $\ast$ {\em lsepw})}}
\label{CDFP_8c_a2}


Constructs (initializes) the compression structure for the appropriate level. 

\begin{Desc}
\item[Returns:]Status\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cdfp}]The compression context to initialize \item[{\em level}]The maximum compression level that needs supporting \item[{\em cfg}]Target specific configuration parameter \item[{\em dgm\-Fw}]The datagram framework handle \item[{\em lsepw}]The generic LSEPW services\end{description}
\end{Desc}
\begin{Desc}
\item[Warning:]It is assumed that the called has used CDFP\_\-sizeof to determine the amount of storage that is needed and, thus, has assured that the {\em cmp\/} structure is adequately sized.\end{Desc}
\hypertarget{CDFP_8c_a1}{
\index{CDFP.c@{CDFP.c}!CDFP_sizeof@{CDFP\_\-sizeof}}
\index{CDFP_sizeof@{CDFP\_\-sizeof}!CDFP.c@{CDFP.c}}
\subsubsection[CDFP\_\-sizeof]{\setlength{\rightskip}{0pt plus 5cm}int CDFP\_\-sizeof (int {\em level}, void $\ast$ {\em cfg})}}
\label{CDFP_8c_a1}


Returns the size, in bytes, of the compression structure needed to supprot the specified compression level. 

\begin{Desc}
\item[Returns:]The size, in bytes, of the compression structure\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em level}]The maximum compression level to support \item[{\em cfg}]Level specific configuration parameter\end{description}
\end{Desc}
\hypertarget{CDFP_8c_a0}{
\index{CDFP.c@{CDFP.c}!composeCtb@{composeCtb}}
\index{composeCtb@{composeCtb}!CDFP.c@{CDFP.c}}
\subsubsection[composeCtb]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline unsigned int $\ast$ compose\-Ctb (\hyperlink{struct__CDFP__ctxCtb}{CDFP\_\-ctx\-Ctb} $\ast$ {\em ctb}, const \hyperlink{struct__CDFP__ctx}{CDFP\_\-ctx} $\ast$ {\em cdfp})\hspace{0.3cm}{\tt  \mbox{[}static\mbox{]}}}}
\label{CDFP_8c_a0}


Composes the CDF LSF contribution. 

\begin{Desc}
\item[Returns:]Pointer to the next fill location\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctb}]The contribution to fill \item[{\em cdfp}]The Compression Data Formatting Physics context\end{description}
\end{Desc}