\hypertarget{QSSP_8h}{
\section{QSSP.h File Reference}
\label{QSSP_8h}\index{QSSP.h@{QSSP.h}}
}
Interface to the Science Statistics for Physics datagrams. 



This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=152pt]{QSSP_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{QSSP_8h_a0}{
typedef \hyperlink{struct__QSSP}{\_\-QSSP} {\bf QSSP}}
\label{QSSP_8h_a0}

\item 
\hypertarget{QSSP_8h_a1}{
typedef \hyperlink{struct__QSSP__ctx}{\_\-QSSP\_\-ctx} {\bf QSSP\_\-ctx}}
\label{QSSP_8h_a1}

\item 
\hypertarget{QSSP_8h_a2}{
typedef \hyperlink{struct__QSSP__sample}{\_\-QSSP\_\-sample} {\bf QSSP\_\-sample}}
\label{QSSP_8h_a2}

\item 
\hypertarget{QSSP_8h_a3}{
typedef \_\-LSF\_\-datagram {\bf LSF\_\-datagram}}
\label{QSSP_8h_a3}

\item 
\hypertarget{QSSP_8h_a4}{
typedef \_\-LSF\_\-contribution {\bf LSF\_\-contribution}}
\label{QSSP_8h_a4}

\item 
\hypertarget{QSSP_8h_a5}{
typedef \_\-LSF\_\-record {\bf LSF\_\-record}}
\label{QSSP_8h_a5}

\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
\hyperlink{struct__QSSP}{QSSP} $\ast$ \hyperlink{QSSP_8h_a6}{QSSP\_\-alloc} (void $\ast$must\_\-be\_\-null)
\begin{CompactList}\small\item\em Allocates and constructs a QSSP handle. \item\end{CompactList}\item 
const LSF\_\-contribution $\ast$ \hyperlink{QSSP_8h_a7}{QSSP\_\-update\-At\-Datagram} (\hyperlink{struct__QSSP}{QSSP} $\ast$qssp, const LSF\_\-datagram $\ast$dgm)
\begin{CompactList}\small\item\em Updates the context at datagram time. \item\end{CompactList}\item 
int \hyperlink{QSSP_8h_a8}{QSSP\_\-update\-At\-Contribution} (\hyperlink{struct__QSSP}{QSSP} $\ast$qssp, const LSF\_\-contribution $\ast$ctb)
\begin{CompactList}\small\item\em Updates the context at datagram time. \item\end{CompactList}\item 
int \hyperlink{QSSP_8h_a9}{QSSP\_\-update\-At\-Record} (\hyperlink{struct__QSSP}{QSSP} $\ast$qssp, const LSF\_\-record $\ast$rec)
\begin{CompactList}\small\item\em Updates the context at record time. \item\end{CompactList}\item 
const \hyperlink{struct__QSSP__sample}{QSSP\_\-sample} $\ast$ \hyperlink{QSSP_8h_a10}{QSSP\_\-retrieve} (const \hyperlink{struct__QSSP}{QSSP} $\ast$qssp)
\begin{CompactList}\small\item\em Retrieves the most recent sample, global or incremental that was processed. \item\end{CompactList}\item 
void \hyperlink{QSSP_8h_a11}{QSSP\_\-destruct} (\hyperlink{struct__QSSP}{QSSP} $\ast$qssp)
\begin{CompactList}\small\item\em The destructor for a QSSP control structure. \item\end{CompactList}\item 
const \hyperlink{struct__QSSP__ctx}{QSSP\_\-ctx} $\ast$ \hyperlink{QSSP_8h_a12}{QSSP\_\-ctx\-Get} (const \hyperlink{struct__QSSP}{QSSP} $\ast$qssp)
\begin{CompactList}\small\item\em Locates the statistics context (meta-data). \item\end{CompactList}\item 
int \hyperlink{QSSP_8h_a13}{QSSP\_\-sizeof} (void $\ast$must\_\-be\_\-null)
\begin{CompactList}\small\item\em Returns the size, in bytes, of a QSS control structure. \item\end{CompactList}\item 
\hyperlink{struct__QSSP}{QSSP} $\ast$ \hyperlink{QSSP_8h_a14}{QSSP\_\-construct} (\hyperlink{struct__QSSP}{QSSP} $\ast$qssp, void $\ast$must\_\-be\_\-null)
\begin{CompactList}\small\item\em The constructor for a QSSP control structure. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Interface to the Science Statistics for Physics datagrams. 

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


\footnotesize\begin{verbatim}   CVS $Id: QSSP.h,v 1.1.1.1 2008/04/02 01:19:26 russell Exp $
\end{verbatim}
\normalsize


\subsection{Function Documentation}
\hypertarget{QSSP_8h_a6}{
\index{QSSP.h@{QSSP.h}!QSSP_alloc@{QSSP\_\-alloc}}
\index{QSSP_alloc@{QSSP\_\-alloc}!QSSP.h@{QSSP.h}}
\subsubsection[QSSP\_\-alloc]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{struct__QSSP}{QSSP}$\ast$ QSSP\_\-alloc (void $\ast$ {\em must\_\-be\_\-null})}}
\label{QSSP_8h_a6}


Allocates and constructs a QSSP handle. 

\begin{Desc}
\item[Returns:]Pointer to the allocated handle\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em must\_\-be\_\-null}]Reserved for future use.\end{description}
\end{Desc}
\hypertarget{QSSP_8h_a14}{
\index{QSSP.h@{QSSP.h}!QSSP_construct@{QSSP\_\-construct}}
\index{QSSP_construct@{QSSP\_\-construct}!QSSP.h@{QSSP.h}}
\subsubsection[QSSP\_\-construct]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{struct__QSSP}{QSSP}$\ast$ QSSP\_\-construct (\hyperlink{struct__QSSP}{QSSP} $\ast$ {\em qssp}, void $\ast$ {\em must\_\-be\_\-null})}}
\label{QSSP_8h_a14}


The constructor for a QSSP control structure. 

\begin{Desc}
\item[Returns:]Pointer to the QSS control structure\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em qssp}]The control structure to be constructed. If NULL, a control structure will be allocated \item[{\em must\_\-be\_\-null}]Reserved for future use.\end{description}
\end{Desc}
\hypertarget{QSSP_8h_a12}{
\index{QSSP.h@{QSSP.h}!QSSP_ctxGet@{QSSP\_\-ctxGet}}
\index{QSSP_ctxGet@{QSSP\_\-ctxGet}!QSSP.h@{QSSP.h}}
\subsubsection[QSSP\_\-ctxGet]{\setlength{\rightskip}{0pt plus 5cm}const \hyperlink{struct__QSSP__ctx}{QSSP\_\-ctx}$\ast$ QSSP\_\-ctx\-Get (const \hyperlink{struct__QSSP}{QSSP} $\ast$ {\em qssp})}}
\label{QSSP_8h_a12}


Locates the statistics context (meta-data). 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em qssp}]The statistics context\end{description}
\end{Desc}
\hypertarget{QSSP_8h_a11}{
\index{QSSP.h@{QSSP.h}!QSSP_destruct@{QSSP\_\-destruct}}
\index{QSSP_destruct@{QSSP\_\-destruct}!QSSP.h@{QSSP.h}}
\subsubsection[QSSP\_\-destruct]{\setlength{\rightskip}{0pt plus 5cm}void QSSP\_\-destruct (\hyperlink{struct__QSSP}{QSSP} $\ast$ {\em qssp})}}
\label{QSSP_8h_a11}


The destructor for a QSSP control structure. 

\begin{Desc}
\item[Returns:]Pointer to the QSS control structure\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em qssp}]The control structure to be destructed.\end{description}
\end{Desc}
\hypertarget{QSSP_8h_a10}{
\index{QSSP.h@{QSSP.h}!QSSP_retrieve@{QSSP\_\-retrieve}}
\index{QSSP_retrieve@{QSSP\_\-retrieve}!QSSP.h@{QSSP.h}}
\subsubsection[QSSP\_\-retrieve]{\setlength{\rightskip}{0pt plus 5cm}const \hyperlink{struct__QSSP__sample}{QSSP\_\-sample}$\ast$ QSSP\_\-retrieve (const \hyperlink{struct__QSSP}{QSSP} $\ast$ {\em qssp})}}
\label{QSSP_8h_a10}


Retrieves the most recent sample, global or incremental that was processed. 

\begin{Desc}
\item[Returns:]Pointer to the sample\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em qssp}]The statistics context\end{description}
\end{Desc}
\hypertarget{QSSP_8h_a13}{
\index{QSSP.h@{QSSP.h}!QSSP_sizeof@{QSSP\_\-sizeof}}
\index{QSSP_sizeof@{QSSP\_\-sizeof}!QSSP.h@{QSSP.h}}
\subsubsection[QSSP\_\-sizeof]{\setlength{\rightskip}{0pt plus 5cm}int QSSP\_\-sizeof (void $\ast$ {\em must\_\-be\_\-null})}}
\label{QSSP_8h_a13}


Returns the size, in bytes, of a QSS control structure. 

\begin{Desc}
\item[Returns:]The size, in bytes, of a QSS control structure\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em must\_\-be\_\-null}]Parameter reserved for future use\end{description}
\end{Desc}
\hypertarget{QSSP_8h_a8}{
\index{QSSP.h@{QSSP.h}!QSSP_updateAtContribution@{QSSP\_\-updateAtContribution}}
\index{QSSP_updateAtContribution@{QSSP\_\-updateAtContribution}!QSSP.h@{QSSP.h}}
\subsubsection[QSSP\_\-updateAtContribution]{\setlength{\rightskip}{0pt plus 5cm}int QSSP\_\-update\-At\-Contribution (\hyperlink{struct__QSSP}{QSSP} $\ast$ {\em qssp}, const LSF\_\-contribution $\ast$ {\em ctb})}}
\label{QSSP_8h_a8}


Updates the context at datagram time. 

\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em If}]have a statistics sample contribution, the number of records in the contribution. \item[{\em $>$0,if}]have a record contributor \item[{\em =0,if}]have the contribution context \item[{\em -1,if}]unrecognized\end{description}
\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em qssp}]The statistics context to update. \item[{\em ctb}]The statistics contribution\end{description}
\end{Desc}
\hypertarget{QSSP_8h_a7}{
\index{QSSP.h@{QSSP.h}!QSSP_updateAtDatagram@{QSSP\_\-updateAtDatagram}}
\index{QSSP_updateAtDatagram@{QSSP\_\-updateAtDatagram}!QSSP.h@{QSSP.h}}
\subsubsection[QSSP\_\-updateAtDatagram]{\setlength{\rightskip}{0pt plus 5cm}const LSF\_\-contribution$\ast$ QSSP\_\-update\-At\-Datagram (\hyperlink{struct__QSSP}{QSSP} $\ast$ {\em qssp}, const LSF\_\-datagram $\ast$ {\em dgm})}}
\label{QSSP_8h_a7}


Updates the context at datagram time. 

\begin{Desc}
\item[Returns:]The contribution to resume processsing at\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em qssp}]The statistics context to update. \item[{\em dgm}]The statistics datagram\end{description}
\end{Desc}
\hypertarget{QSSP_8h_a9}{
\index{QSSP.h@{QSSP.h}!QSSP_updateAtRecord@{QSSP\_\-updateAtRecord}}
\index{QSSP_updateAtRecord@{QSSP\_\-updateAtRecord}!QSSP.h@{QSSP.h}}
\subsubsection[QSSP\_\-updateAtRecord]{\setlength{\rightskip}{0pt plus 5cm}int QSSP\_\-update\-At\-Record (\hyperlink{struct__QSSP}{QSSP} $\ast$ {\em qssp}, const LSF\_\-record $\ast$ {\em rec})}}
\label{QSSP_8h_a9}


Updates the context at record time. 

\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em Non-negative}]values indicate are one of the QSSP\_\-type's \item[{\em Negative}]values indicate an unsuccessful update\end{description}
\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em qssp}]The statistics context to update. \item[{\em rec}]The statistics record\end{description}
\end{Desc}