\hypertarget{QEMP_8h}{
\section{QEMP.h File Reference}
\label{QEMP_8h}\index{QEMP.h@{QEMP.h}}
}
Public interface to the ACD Software Counters. 

{\tt \#include \char`\"{}LSF/LSF.h\char`\"{}}\par
{\tt \#include \char`\"{}EMP/EMP\_\-hdrdefs.h\char`\"{}}\par


Include dependency graph for QEMP.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=129pt]{QEMP_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=95pt]{QEMP_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{QEMP_8h_a0}{
typedef enum \hyperlink{QEMP_8h_a15}{\_\-QEMP\_\-TYPEID} \hyperlink{QEMP_8h_a0}{QEMP\_\-TYPEID}}
\label{QEMP_8h_a0}

\begin{CompactList}\small\item\em type\_\-id used in LSF contributor for QEMP, also returned from \hyperlink{QEMP_8h_a13}{QEMP\_\-typeof()} \item\end{CompactList}\item 
\hypertarget{QEMP_8h_a1}{
typedef enum \hyperlink{QEMP_8h_a16}{\_\-QEMP\_\-STATUS} \hyperlink{QEMP_8h_a1}{QEMP\_\-STATUS}}
\label{QEMP_8h_a1}

\begin{CompactList}\small\item\em Typedef for enum \_\-QSEM\_\-STATUS. \item\end{CompactList}\end{CompactItemize}
\subsection*{Enumerations}
\begin{CompactItemize}
\item 
enum \hyperlink{QEMP_8h_a15}{\_\-QEMP\_\-TYPEID} \{ \par
\hyperlink{QEMP_8h_a15a2}{QEMP\_\-TYPEID\_\-UNKNOWN} =  -1, 
\par
\hyperlink{QEMP_8h_a15a3}{QEMP\_\-TYPEID\_\-ASC} =  0
 \}
\begin{CompactList}\small\item\em Type id used in LSF contributor for uncompressed ASC histogram. \item\end{CompactList}\item 
enum \hyperlink{QEMP_8h_a16}{\_\-QEMP\_\-STATUS} \{ \par
\hyperlink{QEMP_8h_a16a4}{QEMP\_\-STATUS\_\-SUCCESS} =  0, 
\par
\hyperlink{QEMP_8h_a16a5}{QEMP\_\-STATUS\_\-DGM\_\-UNKNOWN\_\-TYPEID} =  -2, 
\par
\hyperlink{QEMP_8h_a16a6}{QEMP\_\-STATUS\_\-DGM\_\-UNKNOWN\_\-VER} =  -3, 
\par
\hyperlink{QEMP_8h_a16a7}{QEMP\_\-STATUS\_\-CTB\_\-UNKNOWN\_\-VER} =  -4, 
\par
\hyperlink{QEMP_8h_a16a8}{QEMP\_\-STATUS\_\-CTB\_\-BAD\_\-LEN32} =  -5, 
\par
\hyperlink{QEMP_8h_a16a9}{QEMP\_\-STATUS\_\-CTB\_\-UNKNOWN\_\-TYPEID} =  -6, 
\par
\hyperlink{QEMP_8h_a16a10}{QEMP\_\-STATUS\_\-CTB\_\-WRONG\_\-TYPEID} =  -7, 
\par
\hyperlink{QEMP_8h_a16a11}{QEMP\_\-STATUS\_\-CTB\_\-INFLATE\_\-FAIL} =  -8
 \}
\begin{CompactList}\small\item\em Enumerates the varios status codes. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
unsigned int \hyperlink{QEMP_8h_a12}{QEMP\_\-sizeof} (\hyperlink{QEMP_8h_a0}{QEMP\_\-TYPEID} typeid)
\begin{CompactList}\small\item\em Return the size, in bytes, of the buffer needed to handle data of the specified type. \item\end{CompactList}\item 
\hyperlink{QEMP_8h_a0}{QEMP\_\-TYPEID} \hyperlink{QEMP_8h_a13}{QEMP\_\-typeof} (const LSF\_\-contribution $\ast$ctb)
\begin{CompactList}\small\item\em Return the type of given contribution. \item\end{CompactList}\item 
const char $\ast$ \hyperlink{QEMP_8h_a14}{QEMP\_\-err\-To\-Str} (\hyperlink{QEMP_8h_a1}{QEMP\_\-STATUS} status)
\begin{CompactList}\small\item\em Convert error code to a string. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Public interface to the ACD Software Counters. 

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


\footnotesize\begin{verbatim}   CVS $Id: QEMP.h,v 1.6 2006/10/21 00:29:59 russell Exp $
\end{verbatim}
\normalsize


\subsection{Enumeration Type Documentation}
\hypertarget{QEMP_8h_a16}{
\index{QEMP.h@{QEMP.h}!_QEMP_STATUS@{\_\-QEMP\_\-STATUS}}
\index{_QEMP_STATUS@{\_\-QEMP\_\-STATUS}!QEMP.h@{QEMP.h}}
\subsubsection[\_\-QEMP\_\-STATUS]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{QEMP_8h_a16}{\_\-QEMP\_\-STATUS}}}
\label{QEMP_8h_a16}


Enumerates the varios status codes. 

\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{QEMP_STATUS_SUCCESS@{QEMP\_\-STATUS\_\-SUCCESS}!QEMP.h@{QEMP.h}}\index{QEMP.h@{QEMP.h}!QEMP_STATUS_SUCCESS@{QEMP\_\-STATUS\_\-SUCCESS}}\item[{\em 
\hypertarget{QEMP_8h_a16a4}{
QEMP\_\-STATUS\_\-SUCCESS}
\label{QEMP_8h_a16a4}
}]All is well \index{QEMP_STATUS_DGM_UNKNOWN_TYPEID@{QEMP\_\-STATUS\_\-DGM\_\-UNKNOWN\_\-TYPEID}!QEMP.h@{QEMP.h}}\index{QEMP.h@{QEMP.h}!QEMP_STATUS_DGM_UNKNOWN_TYPEID@{QEMP\_\-STATUS\_\-DGM\_\-UNKNOWN\_\-TYPEID}}\item[{\em 
\hypertarget{QEMP_8h_a16a5}{
QEMP\_\-STATUS\_\-DGM\_\-UNKNOWN\_\-TYPEID}
\label{QEMP_8h_a16a5}
}]LSF datagram header has typeid which is not in LSF/LSF\_\-ids.h \index{QEMP_STATUS_DGM_UNKNOWN_VER@{QEMP\_\-STATUS\_\-DGM\_\-UNKNOWN\_\-VER}!QEMP.h@{QEMP.h}}\index{QEMP.h@{QEMP.h}!QEMP_STATUS_DGM_UNKNOWN_VER@{QEMP\_\-STATUS\_\-DGM\_\-UNKNOWN\_\-VER}}\item[{\em 
\hypertarget{QEMP_8h_a16a6}{
QEMP\_\-STATUS\_\-DGM\_\-UNKNOWN\_\-VER}
\label{QEMP_8h_a16a6}
}]LSF datagram header has an unknown version number \index{QEMP_STATUS_CTB_UNKNOWN_VER@{QEMP\_\-STATUS\_\-CTB\_\-UNKNOWN\_\-VER}!QEMP.h@{QEMP.h}}\index{QEMP.h@{QEMP.h}!QEMP_STATUS_CTB_UNKNOWN_VER@{QEMP\_\-STATUS\_\-CTB\_\-UNKNOWN\_\-VER}}\item[{\em 
\hypertarget{QEMP_8h_a16a7}{
QEMP\_\-STATUS\_\-CTB\_\-UNKNOWN\_\-VER}
\label{QEMP_8h_a16a7}
}]LSF contributor header has unknown version number \index{QEMP_STATUS_CTB_BAD_LEN32@{QEMP\_\-STATUS\_\-CTB\_\-BAD\_\-LEN32}!QEMP.h@{QEMP.h}}\index{QEMP.h@{QEMP.h}!QEMP_STATUS_CTB_BAD_LEN32@{QEMP\_\-STATUS\_\-CTB\_\-BAD\_\-LEN32}}\item[{\em 
\hypertarget{QEMP_8h_a16a8}{
QEMP\_\-STATUS\_\-CTB\_\-BAD\_\-LEN32}
\label{QEMP_8h_a16a8}
}]LSF contributor has an incorrect length for the packet \index{QEMP_STATUS_CTB_UNKNOWN_TYPEID@{QEMP\_\-STATUS\_\-CTB\_\-UNKNOWN\_\-TYPEID}!QEMP.h@{QEMP.h}}\index{QEMP.h@{QEMP.h}!QEMP_STATUS_CTB_UNKNOWN_TYPEID@{QEMP\_\-STATUS\_\-CTB\_\-UNKNOWN\_\-TYPEID}}\item[{\em 
\hypertarget{QEMP_8h_a16a9}{
QEMP\_\-STATUS\_\-CTB\_\-UNKNOWN\_\-TYPEID}
\label{QEMP_8h_a16a9}
}]LSF contributor header has typeid which is not in QEMP\_\-TYPEID \index{QEMP_STATUS_CTB_WRONG_TYPEID@{QEMP\_\-STATUS\_\-CTB\_\-WRONG\_\-TYPEID}!QEMP.h@{QEMP.h}}\index{QEMP.h@{QEMP.h}!QEMP_STATUS_CTB_WRONG_TYPEID@{QEMP\_\-STATUS\_\-CTB\_\-WRONG\_\-TYPEID}}\item[{\em 
\hypertarget{QEMP_8h_a16a10}{
QEMP\_\-STATUS\_\-CTB\_\-WRONG\_\-TYPEID}
\label{QEMP_8h_a16a10}
}]typeid of data does not match the QEMP\_\-xxx\-Get\-Xxxx \index{QEMP_STATUS_CTB_INFLATE_FAIL@{QEMP\_\-STATUS\_\-CTB\_\-INFLATE\_\-FAIL}!QEMP.h@{QEMP.h}}\index{QEMP.h@{QEMP.h}!QEMP_STATUS_CTB_INFLATE_FAIL@{QEMP\_\-STATUS\_\-CTB\_\-INFLATE\_\-FAIL}}\item[{\em 
\hypertarget{QEMP_8h_a16a11}{
QEMP\_\-STATUS\_\-CTB\_\-INFLATE\_\-FAIL}
\label{QEMP_8h_a16a11}
}]Decompression step failed \end{description}
\end{Desc}

\hypertarget{QEMP_8h_a15}{
\index{QEMP.h@{QEMP.h}!_QEMP_TYPEID@{\_\-QEMP\_\-TYPEID}}
\index{_QEMP_TYPEID@{\_\-QEMP\_\-TYPEID}!QEMP.h@{QEMP.h}}
\subsubsection[\_\-QEMP\_\-TYPEID]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{QEMP_8h_a15}{\_\-QEMP\_\-TYPEID}}}
\label{QEMP_8h_a15}


Type id used in LSF contributor for uncompressed ASC histogram. 

\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{QEMP_TYPEID_UNKNOWN@{QEMP\_\-TYPEID\_\-UNKNOWN}!QEMP.h@{QEMP.h}}\index{QEMP.h@{QEMP.h}!QEMP_TYPEID_UNKNOWN@{QEMP\_\-TYPEID\_\-UNKNOWN}}\item[{\em 
\hypertarget{QEMP_8h_a15a2}{
QEMP\_\-TYPEID\_\-UNKNOWN}
\label{QEMP_8h_a15a2}
}]Contributor type is unknown \index{QEMP_TYPEID_ASC@{QEMP\_\-TYPEID\_\-ASC}!QEMP.h@{QEMP.h}}\index{QEMP.h@{QEMP.h}!QEMP_TYPEID_ASC@{QEMP\_\-TYPEID\_\-ASC}}\item[{\em 
\hypertarget{QEMP_8h_a15a3}{
QEMP\_\-TYPEID\_\-ASC}
\label{QEMP_8h_a15a3}
}]Contributor type is an ASC \end{description}
\end{Desc}



\subsection{Function Documentation}
\hypertarget{QEMP_8h_a14}{
\index{QEMP.h@{QEMP.h}!QEMP_errToStr@{QEMP\_\-errToStr}}
\index{QEMP_errToStr@{QEMP\_\-errToStr}!QEMP.h@{QEMP.h}}
\subsubsection[QEMP\_\-errToStr]{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ QEMP\_\-err\-To\-Str (\hyperlink{QEMP_8h_a1}{QEMP\_\-STATUS} {\em status})}}
\label{QEMP_8h_a14}


Convert error code to a string. 

\begin{Desc}
\item[Returns:]string of error code\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em status}]status codes QEMP\_\-ERR\_\-Xxxx\end{description}
\end{Desc}
---------------------------------------------------------------------- \hypertarget{QEMP_8h_a12}{
\index{QEMP.h@{QEMP.h}!QEMP_sizeof@{QEMP\_\-sizeof}}
\index{QEMP_sizeof@{QEMP\_\-sizeof}!QEMP.h@{QEMP.h}}
\subsubsection[QEMP\_\-sizeof]{\setlength{\rightskip}{0pt plus 5cm}unsigned int QEMP\_\-sizeof (\hyperlink{QEMP_8h_a0}{QEMP\_\-TYPEID} {\em typeid})}}
\label{QEMP_8h_a12}


Return the size, in bytes, of the buffer needed to handle data of the specified type. 

\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em The}]size, in bytes, of the buffer needed to handle data of the specified type. \item[{\em QEMP\_\-STATUS\_\-CTB\_\-UNKNOWN\_\-TYPEID,if}]the type id was not recognized\end{description}
\end{Desc}
\hypertarget{QEMP_8h_a13}{
\index{QEMP.h@{QEMP.h}!QEMP_typeof@{QEMP\_\-typeof}}
\index{QEMP_typeof@{QEMP\_\-typeof}!QEMP.h@{QEMP.h}}
\subsubsection[QEMP\_\-typeof]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{QEMP_8h_a0}{QEMP\_\-TYPEID} QEMP\_\-typeof (const LSF\_\-contribution $\ast$ {\em ctb})}}
\label{QEMP_8h_a13}


Return the type of given contribution. 

\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em QEMP\_\-TYPEID\_\-ASC}]\item[{\em QEMP\_\-TYPEID\_\-UNKNOWN,if}]typeid is not recognized\end{description}
\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctb}]The ontributor to query\end{description}
\end{Desc}
