\hypertarget{QLRA_8h}{
\section{QLRA.h File Reference}
\label{QLRA_8h}\index{QLRA.h@{QLRA.h}}
}
Public definitions for the register display routines. 

{\tt \#include \char`\"{}LRA/LRA.h\char`\"{}}\par


Include dependency graph for QLRA.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=107pt]{QLRA_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=110pt]{QLRA_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{QLRA_8h_a0}{
typedef void($\ast$ \hyperlink{QLRA_8h_a0}{QLRA\_\-regs\-Cb} )(unsigned int secs, LRA\_\-reg\-Data $\ast$r\-Data, void $\ast$parm)}
\label{QLRA_8h_a0}

\begin{CompactList}\small\item\em Callback routines to process LRA data. \item\end{CompactList}\item 
\hypertarget{QLRA_8h_a1}{
typedef void($\ast$ {\bf QLRA\_\-esr\-Cb} )(unsigned int secs, LRA\_\-esr\-Data $\ast$r\-Data, void $\ast$parm)}
\label{QLRA_8h_a1}

\item 
\hypertarget{QLRA_8h_a2}{
typedef void($\ast$ {\bf QLRA\_\-stats\-Cb} )(unsigned int secs, LRA\_\-stats $\ast$s\-Data, void $\ast$parm)}
\label{QLRA_8h_a2}

\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
void \hyperlink{QLRA_8h_a3}{QLRA\_\-disp\-Esr\-Data} (unsigned int secs, LRA\_\-esr\-Data $\ast$r\-Data, void $\ast$parm)
\begin{CompactList}\small\item\em Display error and status register data. \item\end{CompactList}\item 
void \hyperlink{QLRA_8h_a4}{QLRA\_\-disp\-Reg\-Data} (unsigned int secs, LRA\_\-reg\-Data $\ast$r\-Data, void $\ast$parm)
\begin{CompactList}\small\item\em Display register data. \item\end{CompactList}\item 
void \hyperlink{QLRA_8h_a5}{QLRA\_\-disp\-Stats} (unsigned int secs, LRA\_\-stats $\ast$s\-Data, void $\ast$parm)
\begin{CompactList}\small\item\em Display statistics data. \item\end{CompactList}\item 
unsigned \hyperlink{QLRA_8h_a6}{QLRA\_\-read\-Diag} (char $\ast$f\-Name, void $\ast$parm, \hyperlink{QLRA_8h_a0}{QLRA\_\-regs\-Cb} regs\-Rtn)
\begin{CompactList}\small\item\em Read the contents of an LRA packet file. \item\end{CompactList}\item 
unsigned \hyperlink{QLRA_8h_a7}{QLRA\_\-read\-Sci} (char $\ast$f\-Name, void $\ast$parm, \hyperlink{QLRA_8h_a0}{QLRA\_\-regs\-Cb} regs\-Rtn, QLRA\_\-esr\-Cb esr\-Rtn, QLRA\_\-stats\-Cb stats\-Rtn)
\begin{CompactList}\small\item\em Read the contents of an LRA datagram file. \item\end{CompactList}\end{CompactItemize}


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

\begin{Desc}
\item[Author:]Owen H Saxton\end{Desc}
\begin{Desc}
\item[Id]\hyperlink{QLRA_8h}{QLRA.h},v 1.1.1.1 2006/11/01 23:58:10 saxton Exp \end{Desc}


\subsection{Function Documentation}
\hypertarget{QLRA_8h_a3}{
\index{QLRA.h@{QLRA.h}!QLRA_dispEsrData@{QLRA\_\-dispEsrData}}
\index{QLRA_dispEsrData@{QLRA\_\-dispEsrData}!QLRA.h@{QLRA.h}}
\subsubsection[QLRA\_\-dispEsrData]{\setlength{\rightskip}{0pt plus 5cm}void QLRA\_\-disp\-Esr\-Data (unsigned int {\em secs}, LRA\_\-esr\-Data $\ast$ {\em r\-Data}, void $\ast$ {\em parm})}}
\label{QLRA_8h_a3}


Display error and status register data. 

This routine produces a formatted display of the contents of a block of error and status register data.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em secs}]The time the register data was obtained, in spacecraft units.\item[{\em r\-Data}]The register data to be displayed.\item[{\em parm}]Options to modify the display.\end{description}
\end{Desc}
\hypertarget{QLRA_8h_a4}{
\index{QLRA.h@{QLRA.h}!QLRA_dispRegData@{QLRA\_\-dispRegData}}
\index{QLRA_dispRegData@{QLRA\_\-dispRegData}!QLRA.h@{QLRA.h}}
\subsubsection[QLRA\_\-dispRegData]{\setlength{\rightskip}{0pt plus 5cm}void QLRA\_\-disp\-Reg\-Data (unsigned int {\em secs}, LRA\_\-reg\-Data $\ast$ {\em r\-Data}, void $\ast$ {\em parm})}}
\label{QLRA_8h_a4}


Display register data. 

This routine produces a formatted display of the contents of a block of register data.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em secs}]The time the register data was obtained, in spacecraft units.\item[{\em r\-Data}]The register data to be displayed.\item[{\em parm}]Options to modify the display.\end{description}
\end{Desc}
\hypertarget{QLRA_8h_a5}{
\index{QLRA.h@{QLRA.h}!QLRA_dispStats@{QLRA\_\-dispStats}}
\index{QLRA_dispStats@{QLRA\_\-dispStats}!QLRA.h@{QLRA.h}}
\subsubsection[QLRA\_\-dispStats]{\setlength{\rightskip}{0pt plus 5cm}void QLRA\_\-disp\-Stats (unsigned int {\em secs}, LRA\_\-stats $\ast$ {\em s\-Data}, void $\ast$ {\em parm})}}
\label{QLRA_8h_a5}


Display statistics data. 

This routine produces a formatted display of the contents of a block of statistics data.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em secs}]The time the data was sent, in spacecraft units.\item[{\em s\-Data}]The statistics data to be displayed.\item[{\em parm}]Options to modify the display.\end{description}
\end{Desc}
\hypertarget{QLRA_8h_a6}{
\index{QLRA.h@{QLRA.h}!QLRA_readDiag@{QLRA\_\-readDiag}}
\index{QLRA_readDiag@{QLRA\_\-readDiag}!QLRA.h@{QLRA.h}}
\subsubsection[QLRA\_\-readDiag]{\setlength{\rightskip}{0pt plus 5cm}unsigned QLRA\_\-read\-Diag (char $\ast$ {\em f\-Name}, void $\ast$ {\em parm}, \hyperlink{QLRA_8h_a0}{QLRA\_\-regs\-Cb} {\em regs\-Rtn})}}
\label{QLRA_8h_a6}


Read the contents of an LRA packet file. 

This routine reads a file of LRA 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 regs\-Rtn}]Routine to process a set of register data. May be NULL.\end{description}
\end{Desc}
\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em QLRA\_\-SUCCESS}]Success\end{description}
\end{Desc}
\hypertarget{QLRA_8h_a7}{
\index{QLRA.h@{QLRA.h}!QLRA_readSci@{QLRA\_\-readSci}}
\index{QLRA_readSci@{QLRA\_\-readSci}!QLRA.h@{QLRA.h}}
\subsubsection[QLRA\_\-readSci]{\setlength{\rightskip}{0pt plus 5cm}unsigned QLRA\_\-read\-Sci (char $\ast$ {\em f\-Name}, void $\ast$ {\em parm}, \hyperlink{QLRA_8h_a0}{QLRA\_\-regs\-Cb} {\em regs\-Rtn}, QLRA\_\-esr\-Cb {\em esr\-Rtn}, QLRA\_\-stats\-Cb {\em stats\-Rtn})}}
\label{QLRA_8h_a7}


Read the contents of an LRA datagram file. 

This routine reads a file of LRA 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 regs\-Rtn}]Routine to call when a set of register values is read. Can be NULL.\item[{\em esr\-Rtn}]Routine to call when a set of ESR data is read. Can be NULL.\item[{\em stats\-Rtn}]Routine to call when a set of statistics data is read. Can be NULL.\end{description}
\end{Desc}
\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em QLRA\_\-SUCCESS}]Success\end{description}
\end{Desc}