\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
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{QPD_8h_8a7b0e3d6d44be1c61d74810d4ad26f1}{
typedef enum \hyperlink{QPD_8h_d6dba70f63044329242c52eafb1ebb8f}{\_\-QPD\_\-flags} \hyperlink{QPD_8h_8a7b0e3d6d44be1c61d74810d4ad26f1}{QPD\_\-flags}}
\label{QPD_8h_8a7b0e3d6d44be1c61d74810d4ad26f1}

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

\begin{CompactList}\small\item\em Processing options. \item\end{CompactList}\end{CompactItemize}
\subsection*{Enumerations}
\begin{CompactItemize}
\item 
enum \hyperlink{QPD_8h_d6dba70f63044329242c52eafb1ebb8f}{\_\-QPD\_\-flags} \{ \par
\hyperlink{QPD_8h_d6dba70f63044329242c52eafb1ebb8f534f3544f2ef5c069d138ea2a0867e46}{QPD\_\-FLG\_\-FIRST} =  0x01, 
\par
\hyperlink{QPD_8h_d6dba70f63044329242c52eafb1ebb8fcc07a8d6ac10e63824501755a27fe188}{QPD\_\-FLG\_\-LAST} =  0x02, 
\par
\hyperlink{QPD_8h_d6dba70f63044329242c52eafb1ebb8f2205d6fac0ff6c991c33764d47dcffe7}{QPD\_\-FLG\_\-NEW\_\-APID} =  0x04
 \}
\begin{CompactList}\small\item\em Packet options. \item\end{CompactList}\item 
enum \hyperlink{QPD_8h_37ba66d4414c24b21bacdd6f572239bf}{\_\-QPD\_\-optns} \{ \par
\hyperlink{QPD_8h_37ba66d4414c24b21bacdd6f572239bf12913be6bf06bc7e67faf058c5b53a33}{QPD\_\-OPT\_\-HEADER} =  0x01, 
\par
\hyperlink{QPD_8h_37ba66d4414c24b21bacdd6f572239bf9c5ddedd41df36bd256518c735c761b9}{QPD\_\-OPT\_\-VERBOSE} =  0x02, 
\par
\hyperlink{QPD_8h_37ba66d4414c24b21bacdd6f572239bf268b048840e16e86a7e5199c0ab7d27c}{QPD\_\-OPT\_\-BRIEF} =  0x04
 \}
\begin{CompactList}\small\item\em Processing options. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
void \hyperlink{QPD_8h_135b375751ea73d461ac2206a94754d1}{QPD\_\-dispHeader} (\hyperlink{QPD_8h_50f7038a94e87259765aabd12ca36883}{QPD\_\-optns} optns, \hyperlink{QPD_8h_8a7b0e3d6d44be1c61d74810d4ad26f1}{QPD\_\-flags} flags, CCSDS\_\-telemetry $\ast$pkt)
\begin{CompactList}\small\item\em Display a line of packet header data. \item\end{CompactList}\item 
void \hyperlink{QPD_8h_451c06305eae15588492e4882f88ba73}{QPD\_\-dispCmndConf} (\hyperlink{QPD_8h_50f7038a94e87259765aabd12ca36883}{QPD\_\-optns} optns, \hyperlink{QPD_8h_8a7b0e3d6d44be1c61d74810d4ad26f1}{QPD\_\-flags} flags, unsigned secs, ITC\_\-CmdConfirm\_\-Tlm $\ast$pkt)
\begin{CompactList}\small\item\em Display a line of command confirmation data. \item\end{CompactList}\item 
void \hyperlink{QPD_8h_380c3374d15f5e53025e8381c4094452}{QPD\_\-dispLimData} (\hyperlink{QPD_8h_50f7038a94e87259765aabd12ca36883}{QPD\_\-optns} optns, \hyperlink{QPD_8h_8a7b0e3d6d44be1c61d74810d4ad26f1}{QPD\_\-flags} flags, unsigned secs, LIM\_\-State\_\-Tlm $\ast$pkt)
\begin{CompactList}\small\item\em Display a line of LIM state data. \item\end{CompactList}\item 
void \hyperlink{QPD_8h_ebeec84cc676767b8d840cd12869f7ca}{QPD\_\-dispModData} (\hyperlink{QPD_8h_50f7038a94e87259765aabd12ca36883}{QPD\_\-optns} optns, \hyperlink{QPD_8h_8a7b0e3d6d44be1c61d74810d4ad26f1}{QPD\_\-flags} flags, unsigned secs, LCM\_\-LLCMMODLIST\_\-Tlm $\ast$pkt)
\begin{CompactList}\small\item\em Display a line of LCM module data. \item\end{CompactList}\item 
void \hyperlink{QPD_8h_6098ebe271cd66ca1b77216baa2c82cc}{QPD\_\-dispMsgData} (\hyperlink{QPD_8h_50f7038a94e87259765aabd12ca36883}{QPD\_\-optns} optns, \hyperlink{QPD_8h_8a7b0e3d6d44be1c61d74810d4ad26f1}{QPD\_\-flags} flags, unsigned secs, LCM\_\-LCMMSGOUTC\_\-Tlm $\ast$pkt)
\begin{CompactList}\small\item\em Display a line of LCM message data. \item\end{CompactList}\item 
void \hyperlink{QPD_8h_6ad268545383e7c44b963f6b550b9d6c}{QPD\_\-dispTaskData} (\hyperlink{QPD_8h_50f7038a94e87259765aabd12ca36883}{QPD\_\-optns} optns, \hyperlink{QPD_8h_8a7b0e3d6d44be1c61d74810d4ad26f1}{QPD\_\-flags} flags, unsigned secs, LCM\_\-LLCMTASKLIST\_\-Tlm $\ast$pkt)
\begin{CompactList}\small\item\em Display a line of LCM task data. \item\end{CompactList}\item 
int \hyperlink{QPD_8h_892c35073ffe16e08006eda1743156ba}{QPD\_\-msgFormat} (int format)
\begin{CompactList}\small\item\em Set the formatting parameter. \item\end{CompactList}\item 
void \hyperlink{QPD_8h_715fcbfd16c35036e7169447b14117bb}{QPD\_\-msgProc} (MSG\_\-OutputModes 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_bb57675ba5d0ec2936613bd4eaa4de33}{QPD\_\-readDiag} (char $\ast$fName, \hyperlink{QPD_8h_50f7038a94e87259765aabd12ca36883}{QPD\_\-optns} optns)
\begin{CompactList}\small\item\em Read the contents of a packet file. \item\end{CompactList}\item 
char $\ast$ \hyperlink{QPD_8h_17ad6d7036886b6468493ad030993db5}{QPD\_\-msgText} (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]\end{Desc}


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


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_d6dba70f63044329242c52eafb1ebb8f534f3544f2ef5c069d138ea2a0867e46}{
QPD\_\-FLG\_\-FIRST}
\label{QPD_8h_d6dba70f63044329242c52eafb1ebb8f534f3544f2ef5c069d138ea2a0867e46}
}]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_d6dba70f63044329242c52eafb1ebb8fcc07a8d6ac10e63824501755a27fe188}{
QPD\_\-FLG\_\-LAST}
\label{QPD_8h_d6dba70f63044329242c52eafb1ebb8fcc07a8d6ac10e63824501755a27fe188}
}]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_d6dba70f63044329242c52eafb1ebb8f2205d6fac0ff6c991c33764d47dcffe7}{
QPD\_\-FLG\_\-NEW\_\-APID}
\label{QPD_8h_d6dba70f63044329242c52eafb1ebb8f2205d6fac0ff6c991c33764d47dcffe7}
}]APID has changed. \end{description}
\end{Desc}

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


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_37ba66d4414c24b21bacdd6f572239bf12913be6bf06bc7e67faf058c5b53a33}{
QPD\_\-OPT\_\-HEADER}
\label{QPD_8h_37ba66d4414c24b21bacdd6f572239bf12913be6bf06bc7e67faf058c5b53a33}
}]Display all packet headers. \index{QPD_OPT_VERBOSE@{QPD\_\-OPT\_\-VERBOSE}!QPD.h@{QPD.h}}\index{QPD.h@{QPD.h}!QPD_OPT_VERBOSE@{QPD\_\-OPT\_\-VERBOSE}}\item[{\em 
\hypertarget{QPD_8h_37ba66d4414c24b21bacdd6f572239bf9c5ddedd41df36bd256518c735c761b9}{
QPD\_\-OPT\_\-VERBOSE}
\label{QPD_8h_37ba66d4414c24b21bacdd6f572239bf9c5ddedd41df36bd256518c735c761b9}
}]Verbose display. \index{QPD_OPT_BRIEF@{QPD\_\-OPT\_\-BRIEF}!QPD.h@{QPD.h}}\index{QPD.h@{QPD.h}!QPD_OPT_BRIEF@{QPD\_\-OPT\_\-BRIEF}}\item[{\em 
\hypertarget{QPD_8h_37ba66d4414c24b21bacdd6f572239bf268b048840e16e86a7e5199c0ab7d27c}{
QPD\_\-OPT\_\-BRIEF}
\label{QPD_8h_37ba66d4414c24b21bacdd6f572239bf268b048840e16e86a7e5199c0ab7d27c}
}]Brief display. \end{description}
\end{Desc}



\subsection{Function Documentation}
\hypertarget{QPD_8h_451c06305eae15588492e4882f88ba73}{
\index{QPD.h@{QPD.h}!QPD_dispCmndConf@{QPD\_\-dispCmndConf}}
\index{QPD_dispCmndConf@{QPD\_\-dispCmndConf}!QPD.h@{QPD.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void QPD\_\-dispCmndConf ({\bf QPD\_\-optns} {\em optns}, {\bf QPD\_\-flags} {\em flags}, unsigned {\em secs}, ITC\_\-CmdConfirm\_\-Tlm $\ast$ {\em pkt})}}
\label{QPD_8h_451c06305eae15588492e4882f88ba73}


Display a line of command confirmation data. 

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

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em optns}]Display options.\item[{\em flags}]The packet flags.\item[{\em secs}]The time the confirmation was generated, in spacecraft units.\item[{\em pkt}]The command confirmation packet to be displayed. \end{description}
\end{Desc}
\hypertarget{QPD_8h_135b375751ea73d461ac2206a94754d1}{
\index{QPD.h@{QPD.h}!QPD_dispHeader@{QPD\_\-dispHeader}}
\index{QPD_dispHeader@{QPD\_\-dispHeader}!QPD.h@{QPD.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void QPD\_\-dispHeader ({\bf QPD\_\-optns} {\em optns}, {\bf QPD\_\-flags} {\em flags}, CCSDS\_\-telemetry $\ast$ {\em pkt})}}
\label{QPD_8h_135b375751ea73d461ac2206a94754d1}


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 optns}]Display options.\item[{\em flags}]The packet flags.\item[{\em pkt}]The packet header to be displayed. \end{description}
\end{Desc}
\hypertarget{QPD_8h_380c3374d15f5e53025e8381c4094452}{
\index{QPD.h@{QPD.h}!QPD_dispLimData@{QPD\_\-dispLimData}}
\index{QPD_dispLimData@{QPD\_\-dispLimData}!QPD.h@{QPD.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void QPD\_\-dispLimData ({\bf QPD\_\-optns} {\em optns}, {\bf QPD\_\-flags} {\em flags}, unsigned {\em secs}, LIM\_\-State\_\-Tlm $\ast$ {\em pkt})}}
\label{QPD_8h_380c3374d15f5e53025e8381c4094452}


Display a line of LIM state data. 

This routine produces a formatted line from the contents of a packet of LIM state data.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em optns}]Display options.\item[{\em flags}]The packet flags.\item[{\em secs}]The time the task data was obtained, in spacecraft units.\item[{\em pkt}]The packet of state data to be displayed. \end{description}
\end{Desc}
\hypertarget{QPD_8h_ebeec84cc676767b8d840cd12869f7ca}{
\index{QPD.h@{QPD.h}!QPD_dispModData@{QPD\_\-dispModData}}
\index{QPD_dispModData@{QPD\_\-dispModData}!QPD.h@{QPD.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void QPD\_\-dispModData ({\bf QPD\_\-optns} {\em optns}, {\bf QPD\_\-flags} {\em flags}, unsigned {\em secs}, LCM\_\-LLCMMODLIST\_\-Tlm $\ast$ {\em pkt})}}
\label{QPD_8h_ebeec84cc676767b8d840cd12869f7ca}


Display a line of LCM module data. 

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

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em optns}]Display options.\item[{\em flags}]The packet flags.\item[{\em secs}]The time the module data was obtained, in spacecraft units.\item[{\em pkt}]The packet of module data to be displayed. \end{description}
\end{Desc}
\hypertarget{QPD_8h_6098ebe271cd66ca1b77216baa2c82cc}{
\index{QPD.h@{QPD.h}!QPD_dispMsgData@{QPD\_\-dispMsgData}}
\index{QPD_dispMsgData@{QPD\_\-dispMsgData}!QPD.h@{QPD.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void QPD\_\-dispMsgData ({\bf QPD\_\-optns} {\em optns}, {\bf QPD\_\-flags} {\em flags}, unsigned {\em secs}, LCM\_\-LCMMSGOUTC\_\-Tlm $\ast$ {\em pkt})}}
\label{QPD_8h_6098ebe271cd66ca1b77216baa2c82cc}


Display a line of LCM message data. 

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

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em optns}]Display options.\item[{\em flags}]The packet flags.\item[{\em secs}]The time the message data was obtained, in spacecraft units.\item[{\em pkt}]The packet of message data to be displayed. \end{description}
\end{Desc}
\hypertarget{QPD_8h_6ad268545383e7c44b963f6b550b9d6c}{
\index{QPD.h@{QPD.h}!QPD_dispTaskData@{QPD\_\-dispTaskData}}
\index{QPD_dispTaskData@{QPD\_\-dispTaskData}!QPD.h@{QPD.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void QPD\_\-dispTaskData ({\bf QPD\_\-optns} {\em optns}, {\bf QPD\_\-flags} {\em flags}, unsigned {\em secs}, LCM\_\-LLCMTASKLIST\_\-Tlm $\ast$ {\em pkt})}}
\label{QPD_8h_6ad268545383e7c44b963f6b550b9d6c}


Display a line of LCM task data. 

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

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em optns}]Display options.\item[{\em flags}]The packet flags.\item[{\em secs}]The time the task data was obtained, in spacecraft units.\item[{\em pkt}]The packet of task data to be displayed. \end{description}
\end{Desc}
\hypertarget{QPD_8h_892c35073ffe16e08006eda1743156ba}{
\index{QPD.h@{QPD.h}!QPD_msgFormat@{QPD\_\-msgFormat}}
\index{QPD_msgFormat@{QPD\_\-msgFormat}!QPD.h@{QPD.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int QPD\_\-msgFormat (int {\em format})}}
\label{QPD_8h_892c35073ffe16e08006eda1743156ba}


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\_\-msgText 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_715fcbfd16c35036e7169447b14117bb}{
\index{QPD.h@{QPD.h}!QPD_msgProc@{QPD\_\-msgProc}}
\index{QPD_msgProc@{QPD\_\-msgProc}!QPD.h@{QPD.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void QPD\_\-msgProc (MSG\_\-OutputModes {\em mode}, void $\ast$ {\em parm}, const MSG\_\-Message $\ast$ {\em msg})}}
\label{QPD_8h_715fcbfd16c35036e7169447b14117bb}


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_17ad6d7036886b6468493ad030993db5}{
\index{QPD.h@{QPD.h}!QPD_msgText@{QPD\_\-msgText}}
\index{QPD_msgText@{QPD\_\-msgText}!QPD.h@{QPD.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ QPD\_\-msgText (void)}}
\label{QPD_8h_17ad6d7036886b6468493ad030993db5}


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_bb57675ba5d0ec2936613bd4eaa4de33}{
\index{QPD.h@{QPD.h}!QPD_readDiag@{QPD\_\-readDiag}}
\index{QPD_readDiag@{QPD\_\-readDiag}!QPD.h@{QPD.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned QPD\_\-readDiag (char $\ast$ {\em fName}, {\bf QPD\_\-optns} {\em optns})}}
\label{QPD_8h_bb57675ba5d0ec2936613bd4eaa4de33}


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 fName}]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}
