\hypertarget{QLMC_8h}{
\section{QLMC.h File Reference}
\label{QLMC_8h}\index{QLMC.h@{QLMC.h}}
}
Public definitions for the LMC data display routines. 



This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=111pt]{QLMC_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{QLMC_8h_a0}{
typedef void($\ast$ \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} )(unsigned int secs, char $\ast$pkt, int pkt\-L, void $\ast$parm)}
\label{QLMC_8h_a0}

\begin{CompactList}\small\item\em Callback routine to process LMC packet data. \item\end{CompactList}\end{CompactItemize}
\subsection*{Enumerations}
\begin{CompactItemize}
\item 
enum \{ \par
\hyperlink{QLMC_8h_a9a1}{QLMC\_\-DOPT\_\-PLAIN} =  0x01, 
\par
\hyperlink{QLMC_8h_a9a2}{QLMC\_\-DOPT\_\-NOHDR} =  0x02
 \}
\begin{CompactList}\small\item\em Miscellaneous definitions. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
unsigned \hyperlink{QLMC_8h_a3}{QLMC\_\-read\-Diag} (char $\ast$f\-Name, void $\ast$parm, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} cal\-Rtn, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} tkr\-Rtn, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} acd\-Rtn, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} dead\-Rtn)
\begin{CompactList}\small\item\em Read the contents of an LMC packet file. \item\end{CompactList}\item 
unsigned \hyperlink{QLMC_8h_a4}{QLMC\_\-read\-Sci} (char $\ast$f\-Name, void $\ast$parm, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} cal\-Rtn, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} tkr\-Rtn, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} acd\-Rtn, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} dead\-Rtn)
\begin{CompactList}\small\item\em Read the contents of an LMC datagram file. \item\end{CompactList}\item 
void \hyperlink{QLMC_8h_a5}{QLMC\_\-disp\-Cal\-Data} (unsigned int secs, char $\ast$pkt, int pkt\-L, void $\ast$parm)
\begin{CompactList}\small\item\em Display LMC calorimeter data. \item\end{CompactList}\item 
void \hyperlink{QLMC_8h_a6}{QLMC\_\-disp\-Tkr\-Data} (unsigned int secs, char $\ast$pkt, int pkt\-L, void $\ast$parm)
\begin{CompactList}\small\item\em Display LMC tracker data. \item\end{CompactList}\item 
void \hyperlink{QLMC_8h_a7}{QLMC\_\-disp\-Acd\-Data} (unsigned int secs, char $\ast$pkt, int pkt\-L, void $\ast$parm)
\begin{CompactList}\small\item\em Display LMC ACD tile data. \item\end{CompactList}\item 
void \hyperlink{QLMC_8h_a8}{QLMC\_\-disp\-Dead\-Data} (unsigned int secs, char $\ast$pkt, int pkt\-L, void $\ast$parm)
\begin{CompactList}\small\item\em Display LMC TEM dead time data. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Public definitions for the LMC data display routines. 

\begin{Desc}
\item[Author:]Owen H Saxton\end{Desc}
\begin{Desc}
\item[Id]\hyperlink{QLMC_8h}{QLMC.h},v 1.1.1.1 2007/12/11 23:08:20 saxton Exp \end{Desc}


\subsection{Enumeration Type Documentation}
\hypertarget{QLMC_8h_a9}{
\subsubsection["@0]{\setlength{\rightskip}{0pt plus 5cm}anonymous enum}}
\label{QLMC_8h_a9}


Miscellaneous definitions. 

\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{QLMC_DOPT_PLAIN@{QLMC\_\-DOPT\_\-PLAIN}!QLMC.h@{QLMC.h}}\index{QLMC.h@{QLMC.h}!QLMC_DOPT_PLAIN@{QLMC\_\-DOPT\_\-PLAIN}}\item[{\em 
\hypertarget{QLMC_8h_a9a1}{
QLMC\_\-DOPT\_\-PLAIN}
\label{QLMC_8h_a9a1}
}]Do plain display. \index{QLMC_DOPT_NOHDR@{QLMC\_\-DOPT\_\-NOHDR}!QLMC.h@{QLMC.h}}\index{QLMC.h@{QLMC.h}!QLMC_DOPT_NOHDR@{QLMC\_\-DOPT\_\-NOHDR}}\item[{\em 
\hypertarget{QLMC_8h_a9a2}{
QLMC\_\-DOPT\_\-NOHDR}
\label{QLMC_8h_a9a2}
}]Don't display header line. \end{description}
\end{Desc}



\subsection{Function Documentation}
\hypertarget{QLMC_8h_a7}{
\index{QLMC.h@{QLMC.h}!QLMC_dispAcdData@{QLMC\_\-dispAcdData}}
\index{QLMC_dispAcdData@{QLMC\_\-dispAcdData}!QLMC.h@{QLMC.h}}
\subsubsection[QLMC\_\-dispAcdData]{\setlength{\rightskip}{0pt plus 5cm}void QLMC\_\-disp\-Acd\-Data (unsigned int {\em secs}, char $\ast$ {\em pkt}, int {\em pkt\-L}, void $\ast$ {\em parm})}}
\label{QLMC_8h_a7}


Display LMC ACD tile data. 

This routine produces a formatted display of the contents of a packet of LMC ACD tile data.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em secs}]The time the register data was obtained, in spacecraft units.\item[{\em pkt}]The address of the packet.\item[{\em pkt\-L}]The number of bytes in the packet.\item[{\em parm}]Options to modify the display.\end{description}
\end{Desc}
\hypertarget{QLMC_8h_a5}{
\index{QLMC.h@{QLMC.h}!QLMC_dispCalData@{QLMC\_\-dispCalData}}
\index{QLMC_dispCalData@{QLMC\_\-dispCalData}!QLMC.h@{QLMC.h}}
\subsubsection[QLMC\_\-dispCalData]{\setlength{\rightskip}{0pt plus 5cm}void QLMC\_\-disp\-Cal\-Data (unsigned int {\em secs}, char $\ast$ {\em pkt}, int {\em pkt\-L}, void $\ast$ {\em parm})}}
\label{QLMC_8h_a5}


Display LMC calorimeter data. 

This routine produces a formatted display of the contents of a packet of LMC calorimeter data.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em secs}]The time the register data was obtained, in spacecraft units.\item[{\em pkt}]The address of the packet.\item[{\em pkt\-L}]The number of bytes in the packet.\item[{\em parm}]Options to modify the display.\end{description}
\end{Desc}
\hypertarget{QLMC_8h_a8}{
\index{QLMC.h@{QLMC.h}!QLMC_dispDeadData@{QLMC\_\-dispDeadData}}
\index{QLMC_dispDeadData@{QLMC\_\-dispDeadData}!QLMC.h@{QLMC.h}}
\subsubsection[QLMC\_\-dispDeadData]{\setlength{\rightskip}{0pt plus 5cm}void QLMC\_\-disp\-Dead\-Data (unsigned int {\em secs}, char $\ast$ {\em pkt}, int {\em pkt\-L}, void $\ast$ {\em parm})}}
\label{QLMC_8h_a8}


Display LMC TEM dead time data. 

This routine produces a formatted display of the contents of a packet of LMC TEM dead time data.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em secs}]The time the register data was obtained, in spacecraft units.\item[{\em pkt}]The address of the packet.\item[{\em pkt\-L}]The number of bytes in the packet.\item[{\em parm}]Options to modify the display.\end{description}
\end{Desc}
\hypertarget{QLMC_8h_a6}{
\index{QLMC.h@{QLMC.h}!QLMC_dispTkrData@{QLMC\_\-dispTkrData}}
\index{QLMC_dispTkrData@{QLMC\_\-dispTkrData}!QLMC.h@{QLMC.h}}
\subsubsection[QLMC\_\-dispTkrData]{\setlength{\rightskip}{0pt plus 5cm}void QLMC\_\-disp\-Tkr\-Data (unsigned int {\em secs}, char $\ast$ {\em pkt}, int {\em pkt\-L}, void $\ast$ {\em parm})}}
\label{QLMC_8h_a6}


Display LMC tracker data. 

This routine produces a formatted display of the contents of a packet of LMC tracker data.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em secs}]The time the register data was obtained, in spacecraft units.\item[{\em pkt}]The address of the packet.\item[{\em pkt\-L}]The number of bytes in the packet.\item[{\em parm}]Options to modify the display.\end{description}
\end{Desc}
\hypertarget{QLMC_8h_a3}{
\index{QLMC.h@{QLMC.h}!QLMC_readDiag@{QLMC\_\-readDiag}}
\index{QLMC_readDiag@{QLMC\_\-readDiag}!QLMC.h@{QLMC.h}}
\subsubsection[QLMC\_\-readDiag]{\setlength{\rightskip}{0pt plus 5cm}unsigned QLMC\_\-read\-Diag (char $\ast$ {\em f\-Name}, void $\ast$ {\em parm}, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} {\em cal\-Rtn}, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} {\em tkr\-Rtn}, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} {\em acd\-Rtn}, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} {\em dead\-Rtn})}}
\label{QLMC_8h_a3}


Read the contents of an LMC packet file. 

This routine reads a file of LMC diagnostic data returned from the LAT and calls a processing routine whenever a complete set of data has been assemnled.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em f\-Name}]The name of the file to be processed\item[{\em parm}]User parameter to pass to the processing routine.\item[{\em cal\-Rtn}]Routine to call when a packet of LMC calorimeter data is read. Can be NULL.\item[{\em tkr\-Rtn}]Routine to call when a packet of LMC tracker data is read. Can be NULL.\item[{\em acd\-Rtn}]Routine to call when a packet of LMC ACD tile data is read. Can be NULL.\item[{\em dead\-Rtn}]Routine to call when a packet of LMC TEM deadtime data is read. Can be NULL.\end{description}
\end{Desc}
\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em QLMC\_\-SUCCESS}]Success\end{description}
\end{Desc}
\hypertarget{QLMC_8h_a4}{
\index{QLMC.h@{QLMC.h}!QLMC_readSci@{QLMC\_\-readSci}}
\index{QLMC_readSci@{QLMC\_\-readSci}!QLMC.h@{QLMC.h}}
\subsubsection[QLMC\_\-readSci]{\setlength{\rightskip}{0pt plus 5cm}unsigned QLMC\_\-read\-Sci (char $\ast$ {\em f\-Name}, void $\ast$ {\em parm}, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} {\em cal\-Rtn}, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} {\em tkr\-Rtn}, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} {\em acd\-Rtn}, \hyperlink{QLMC_8h_a0}{QLMC\_\-pkt\-Cb} {\em dead\-Rtn})}}
\label{QLMC_8h_a4}


Read the contents of an LMC datagram file. 

This routine reads a file of LMC datagrams returned from the LAT, and calls a user-supplied processing routine for each type of data found.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em f\-Name}]The name of the file to be displayed\item[{\em parm}]User parameter to pass to the processing routine.\item[{\em cal\-Rtn}]Routine to call when a packet of LMC calorimeter data is read. Can be NULL.\item[{\em tkr\-Rtn}]Routine to call when a packet of LMC tracker data is read. Can be NULL.\item[{\em acd\-Rtn}]Routine to call when a packet of LMC ACD tile data is read. Can be NULL.\item[{\em dead\-Rtn}]Routine to call when a packet of LMC TEM deadtime data is read. Can be NULL.\end{description}
\end{Desc}
\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em QLMC\_\-SUCCESS}]Success\end{description}
\end{Desc}
