\hypertarget{QPD_8h}{
\section{QPD.h File Reference}
\label{QPD_8h}\index{QPD.h@{QPD.h}}
}
Public definitions for the packet display routines. 

{\tt \#include \char`\"{}QSD/CCSDS\_\-telemetry.h\char`\"{}}\par
{\tt \#include \char`\"{}ITC/ITC\_\-tlmdefs.h\char`\"{}}\par
{\tt \#include \char`\"{}LCM/LCM\_\-tlmdefs.h\char`\"{}}\par
{\tt \#include \char`\"{}LIM/LIM\_\-tlmdefs.h\char`\"{}}\par
{\tt \#include \char`\"{}MSG/MSG\_\-pubdefs.h\char`\"{}}\par


Include dependency graph for QPD.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=133pt]{QPD_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]{QPD_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{QPD_8h_a0}{
typedef enum \hyperlink{QPD_8h_a15}{\_\-QPD\_\-flags} \hyperlink{QPD_8h_a0}{QPD\_\-flags}}
\label{QPD_8h_a0}

\begin{CompactList}\small\item\em Packet options. \item\end{CompactList}\item 
\hypertarget{QPD_8h_a1}{
typedef enum \hyperlink{QPD_8h_a16}{\_\-QPD\_\-optns} \hyperlink{QPD_8h_a1}{QPD\_\-optns}}
\label{QPD_8h_a1}

\begin{CompactList}\small\item\em Processing options. \item\end{CompactList}\end{CompactItemize}
\subsection*{Enumerations}
\begin{CompactItemize}
\item 
enum \hyperlink{QPD_8h_a15}{\_\-QPD\_\-flags} \{ \par
\hyperlink{QPD_8h_a15a2}{QPD\_\-FLG\_\-FIRST} =  0x01, 
\par
\hyperlink{QPD_8h_a15a3}{QPD\_\-FLG\_\-LAST} =  0x02, 
\par
\hyperlink{QPD_8h_a15a4}{QPD\_\-FLG\_\-NEW\_\-APID} =  0x04
 \}
\begin{CompactList}\small\item\em Packet options. \item\end{CompactList}\item 
enum \hyperlink{QPD_8h_a16}{\_\-QPD\_\-optns} \{ \hyperlink{QPD_8h_a16a5}{QPD\_\-OPT\_\-HEADER} =  0x01
 \}
\begin{CompactList}\small\item\em Processing options. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
void \hyperlink{QPD_8h_a6}{QPD\_\-disp\-Header} (int flags, CCSDS\_\-telemetry $\ast$pkt)
\begin{CompactList}\small\item\em Display a line of packet header data. \item\end{CompactList}\item 
\hypertarget{QPD_8h_a7}{
void {\bf QPD\_\-disp\-Cmnd\-Conf} (\hyperlink{QPD_8h_a0}{QPD\_\-flags} flags, unsigned secs, ITC\_\-Cmd\-Confirm\_\-Tlm $\ast$pkt)}
\label{QPD_8h_a7}

\item 
\hypertarget{QPD_8h_a8}{
void {\bf QPD\_\-disp\-Lim\-Data} (\hyperlink{QPD_8h_a0}{QPD\_\-flags} flags, unsigned secs, LIM\_\-State\_\-Tlm $\ast$pkt)}
\label{QPD_8h_a8}

\item 
\hypertarget{QPD_8h_a9}{
void {\bf QPD\_\-disp\-Mod\-Data} (\hyperlink{QPD_8h_a0}{QPD\_\-flags} flags, unsigned secs, LCM\_\-LLCMMODLIST\_\-Tlm $\ast$pkt)}
\label{QPD_8h_a9}

\item 
\hypertarget{QPD_8h_a10}{
void {\bf QPD\_\-disp\-Task\-Data} (\hyperlink{QPD_8h_a0}{QPD\_\-flags} flags, unsigned secs, LCM\_\-LLCMTASKLIST\_\-Tlm $\ast$pkt)}
\label{QPD_8h_a10}

\item 
int \hyperlink{QPD_8h_a11}{QPD\_\-msg\-Format} (int format)
\begin{CompactList}\small\item\em Set the formatting parameter. \item\end{CompactList}\item 
void \hyperlink{QPD_8h_a12}{QPD\_\-msg\-Proc} (MSG\_\-Output\-Modes mode, void $\ast$parm, const MSG\_\-Message $\ast$msg)
\begin{CompactList}\small\item\em Process an error message. \item\end{CompactList}\item 
unsigned \hyperlink{QPD_8h_a13}{QPD\_\-read\-Diag} (char $\ast$f\-Name, \hyperlink{QPD_8h_a1}{QPD\_\-optns} optns)
\begin{CompactList}\small\item\em Read the contents of a packet file. \item\end{CompactList}\item 
char $\ast$ \hyperlink{QPD_8h_a14}{QPD\_\-msg\-Text} (void)
\begin{CompactList}\small\item\em Get the message test. \item\end{CompactList}\end{CompactItemize}


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

\begin{Desc}
\item[Author:]Owen H Saxton\end{Desc}
\begin{Desc}
\item[Id]\hyperlink{QPD_8h}{QPD.h},v 1.1.1.1 2008/04/04 19:24:22 saxton Exp \end{Desc}


\subsection{Enumeration Type Documentation}
\hypertarget{QPD_8h_a15}{
\index{QPD.h@{QPD.h}!_QPD_flags@{\_\-QPD\_\-flags}}
\index{_QPD_flags@{\_\-QPD\_\-flags}!QPD.h@{QPD.h}}
\subsubsection[\_\-QPD\_\-flags]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{QPD_8h_a15}{\_\-QPD\_\-flags}}}
\label{QPD_8h_a15}


Packet options. 

\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{QPD_FLG_FIRST@{QPD\_\-FLG\_\-FIRST}!QPD.h@{QPD.h}}\index{QPD.h@{QPD.h}!QPD_FLG_FIRST@{QPD\_\-FLG\_\-FIRST}}\item[{\em 
\hypertarget{QPD_8h_a15a2}{
QPD\_\-FLG\_\-FIRST}
\label{QPD_8h_a15a2}
}]First packet of a sequence. \index{QPD_FLG_LAST@{QPD\_\-FLG\_\-LAST}!QPD.h@{QPD.h}}\index{QPD.h@{QPD.h}!QPD_FLG_LAST@{QPD\_\-FLG\_\-LAST}}\item[{\em 
\hypertarget{QPD_8h_a15a3}{
QPD\_\-FLG\_\-LAST}
\label{QPD_8h_a15a3}
}]Last packet of a sequence. \index{QPD_FLG_NEW_APID@{QPD\_\-FLG\_\-NEW\_\-APID}!QPD.h@{QPD.h}}\index{QPD.h@{QPD.h}!QPD_FLG_NEW_APID@{QPD\_\-FLG\_\-NEW\_\-APID}}\item[{\em 
\hypertarget{QPD_8h_a15a4}{
QPD\_\-FLG\_\-NEW\_\-APID}
\label{QPD_8h_a15a4}
}]APID has changed. \end{description}
\end{Desc}

\hypertarget{QPD_8h_a16}{
\index{QPD.h@{QPD.h}!_QPD_optns@{\_\-QPD\_\-optns}}
\index{_QPD_optns@{\_\-QPD\_\-optns}!QPD.h@{QPD.h}}
\subsubsection[\_\-QPD\_\-optns]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{QPD_8h_a16}{\_\-QPD\_\-optns}}}
\label{QPD_8h_a16}


Processing options. 

\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{QPD_OPT_HEADER@{QPD\_\-OPT\_\-HEADER}!QPD.h@{QPD.h}}\index{QPD.h@{QPD.h}!QPD_OPT_HEADER@{QPD\_\-OPT\_\-HEADER}}\item[{\em 
\hypertarget{QPD_8h_a16a5}{
QPD\_\-OPT\_\-HEADER}
\label{QPD_8h_a16a5}
}]Display all packet headers. \end{description}
\end{Desc}



\subsection{Function Documentation}
\hypertarget{QPD_8h_a6}{
\index{QPD.h@{QPD.h}!QPD_dispHeader@{QPD\_\-dispHeader}}
\index{QPD_dispHeader@{QPD\_\-dispHeader}!QPD.h@{QPD.h}}
\subsubsection[QPD\_\-dispHeader]{\setlength{\rightskip}{0pt plus 5cm}void QPD\_\-disp\-Header (int {\em flags}, CCSDS\_\-telemetry $\ast$ {\em pkt})}}
\label{QPD_8h_a6}


Display a line of packet header data. 

This routine produces a formatted line from the contents of a packet header.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em flags}]The packet flags.\item[{\em pkt}]The packet header to be displayed.\end{description}
\end{Desc}
\hypertarget{QPD_8h_a11}{
\index{QPD.h@{QPD.h}!QPD_msgFormat@{QPD\_\-msgFormat}}
\index{QPD_msgFormat@{QPD\_\-msgFormat}!QPD.h@{QPD.h}}
\subsubsection[QPD\_\-msgFormat]{\setlength{\rightskip}{0pt plus 5cm}int QPD\_\-msg\-Format (int {\em format})}}
\label{QPD_8h_a11}


Set the formatting parameter. 

This routine sets the message formatting parameter. When zero, messages are formatted in the standard way and output to the terminal. When non-zero, messages are briefly formatted and stored locally, to be retrieved via the QPD\_\-msg\-Text routine.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em format}]The formatting parameter value to set.\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The previous value of the formatting parameter.\end{Desc}
\hypertarget{QPD_8h_a12}{
\index{QPD.h@{QPD.h}!QPD_msgProc@{QPD\_\-msgProc}}
\index{QPD_msgProc@{QPD\_\-msgProc}!QPD.h@{QPD.h}}
\subsubsection[QPD\_\-msgProc]{\setlength{\rightskip}{0pt plus 5cm}void QPD\_\-msg\-Proc (MSG\_\-Output\-Modes {\em mode}, void $\ast$ {\em parm}, const MSG\_\-Message $\ast$ {\em msg})}}
\label{QPD_8h_a12}


Process an error message. 

This routine is an output processor for the message system. It in general prints the message in a simple format. Using a static flag, it can also format the message into a static area when requested to.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mode}]Calling mode (initial, normal, exit)\item[{\em parm}]User parameter (not used)\item[{\em msg}]The message to be output\end{description}
\end{Desc}
\hypertarget{QPD_8h_a14}{
\index{QPD.h@{QPD.h}!QPD_msgText@{QPD\_\-msgText}}
\index{QPD_msgText@{QPD\_\-msgText}!QPD.h@{QPD.h}}
\subsubsection[QPD\_\-msgText]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ QPD\_\-msg\-Text (void)}}
\label{QPD_8h_a14}


Get the message test. 

This routine returns the address of the last stored message.

\begin{Desc}
\item[Returns:]The addres of the message text.\end{Desc}
\hypertarget{QPD_8h_a13}{
\index{QPD.h@{QPD.h}!QPD_readDiag@{QPD\_\-readDiag}}
\index{QPD_readDiag@{QPD\_\-readDiag}!QPD.h@{QPD.h}}
\subsubsection[QPD\_\-readDiag]{\setlength{\rightskip}{0pt plus 5cm}unsigned QPD\_\-read\-Diag (char $\ast$ {\em f\-Name}, \hyperlink{QPD_8h_a1}{QPD\_\-optns} {\em optns})}}
\label{QPD_8h_a13}


Read the contents of a packet file. 

This routine reads a file of diagnostic data returned from the LAT and calls a processing routine for each received packet.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em f\-Name}]The name of the file to be processed\item[{\em optns}]Various processing options\end{description}
\end{Desc}
\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em QPD\_\-SUCCESS}]Success\end{description}
\end{Desc}
