GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> QPD / V2-0-4 > qpd / rhel5-32


Interface   Data Structures   File List   Data Fields   Globals  

QPD.h File Reference

Public definitions for the packet display routines. More...

#include <QSD/CCSDS_telemetry.h>
#include <ITC/ITC_tlmdefs.h>
#include <LCM/LCM_tlmdefs.h>
#include <LIM/LIM_tlmdefs.h>
#include <MSG/MSG_pubdefs.h>

Typedefs

typedef enum _QPD_flags QPD_flags
 Packet options.
typedef enum _QPD_optns QPD_optns
 Processing options.

Enumerations

enum  _QPD_flags {
  QPD_FLG_FIRST = 0x01,
  QPD_FLG_LAST = 0x02,
  QPD_FLG_NEW_APID = 0x04
}
 Packet options. More...
enum  _QPD_optns {
  QPD_OPT_HEADER = 0x01,
  QPD_OPT_VERBOSE = 0x02,
  QPD_OPT_BRIEF = 0x04
}
 Processing options. More...

Functions

void QPD_dispHeader (QPD_optns optns, QPD_flags flags, CCSDS_telemetry *pkt)
 Display a line of packet header data.
void QPD_dispCmndConf (QPD_optns optns, QPD_flags flags, unsigned secs, ITC_CmdConfirm_Tlm *pkt)
 Display a line of command confirmation data.
void QPD_dispLimData (QPD_optns optns, QPD_flags flags, unsigned secs, LIM_State_Tlm *pkt)
 Display a line of LIM state data.
void QPD_dispModData (QPD_optns optns, QPD_flags flags, unsigned secs, LCM_LLCMMODLIST_Tlm *pkt)
 Display a line of LCM module data.
void QPD_dispMsgData (QPD_optns optns, QPD_flags flags, unsigned secs, LCM_LCMMSGOUTC_Tlm *pkt)
 Display a line of LCM message data.
void QPD_dispTaskData (QPD_optns optns, QPD_flags flags, unsigned secs, LCM_LLCMTASKLIST_Tlm *pkt)
 Display a line of LCM task data.
int QPD_msgFormat (int format)
 Set the formatting parameter.
void QPD_msgProc (MSG_OutputModes mode, void *parm, const MSG_Message *msg)
 Process an error message.
unsigned QPD_readDiag (char *fName, QPD_optns optns)
 Read the contents of a packet file.
char * QPD_msgText (void)
 Get the message test.


Detailed Description

Public definitions for the packet display routines.

Author:
Owen H Saxton
Id
QPD.h,v 1.3 2011/03/30 20:13:52 saxton Exp

Enumeration Type Documentation

enum _QPD_flags

Packet options.

Enumerator:
QPD_FLG_FIRST  First packet of a sequence.
QPD_FLG_LAST  Last packet of a sequence.
QPD_FLG_NEW_APID  APID has changed.

enum _QPD_optns

Processing options.

Enumerator:
QPD_OPT_HEADER  Display all packet headers.
QPD_OPT_VERBOSE  Verbose display.
QPD_OPT_BRIEF  Brief display.


Function Documentation

void QPD_dispCmndConf ( QPD_optns  optns,
QPD_flags  flags,
unsigned  secs,
ITC_CmdConfirm_Tlm *  pkt 
)

Display a line of command confirmation data.

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

Parameters:
optns Display options.
flags The packet flags.
secs The time the confirmation was generated, in spacecraft units.
pkt The command confirmation packet to be displayed.

References QPD_FLG_NEW_APID, QPD_msgFormat(), QPD_msgText(), and secsToStr().

Referenced by QPD_readDiag().

void QPD_dispHeader ( QPD_optns  optns,
QPD_flags  flags,
CCSDS_telemetry *  pkt 
)

Display a line of packet header data.

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

Parameters:
optns Display options.
flags The packet flags.
pkt The packet header to be displayed.

References QPD_FLG_FIRST, and secsToStr().

Referenced by QPD_readDiag().

void QPD_dispLimData ( QPD_optns  optns,
QPD_flags  flags,
unsigned  secs,
LIM_State_Tlm *  pkt 
)

Display a line of LIM state data.

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

Parameters:
optns Display options.
flags The packet flags.
secs The time the task data was obtained, in spacecraft units.
pkt The packet of state data to be displayed.

References QPD_FLG_NEW_APID, QPD_msgFormat(), QPD_msgText(), and secsToStr().

Referenced by QPD_readDiag().

void QPD_dispModData ( QPD_optns  optns,
QPD_flags  flags,
unsigned  secs,
LCM_LLCMMODLIST_Tlm *  pkt 
)

Display a line of LCM module data.

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

Parameters:
optns Display options.
flags The packet flags.
secs The time the module data was obtained, in spacecraft units.
pkt The packet of module data to be displayed.

References QPD_FLG_FIRST, QPD_FLG_LAST, and secsToStr().

Referenced by QPD_readDiag().

void QPD_dispMsgData ( QPD_optns  optns,
QPD_flags  flags,
unsigned  secs,
LCM_LCMMSGOUTC_Tlm *  pkt 
)

Display a line of LCM message data.

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

Parameters:
optns Display options.
flags The packet flags.
secs The time the message data was obtained, in spacecraft units.
pkt The packet of message data to be displayed.

References QPD_FLG_NEW_APID, QPD_OPT_VERBOSE, secsToStr(), and strLeng().

Referenced by QPD_readDiag().

void QPD_dispTaskData ( QPD_optns  optns,
QPD_flags  flags,
unsigned  secs,
LCM_LLCMTASKLIST_Tlm *  pkt 
)

Display a line of LCM task data.

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

Parameters:
optns Display options.
flags The packet flags.
secs The time the task data was obtained, in spacecraft units.
pkt The packet of task data to be displayed.

References QPD_FLG_FIRST, QPD_FLG_LAST, and secsToStr().

Referenced by QPD_readDiag().

int QPD_msgFormat ( int  format  ) 

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.

Parameters:
format The formatting parameter value to set.
Returns:
The previous value of the formatting parameter.

Referenced by QPD_dispCmndConf(), and QPD_dispLimData().

void QPD_msgProc ( MSG_OutputModes  mode,
void *  parm,
const MSG_Message *  msg 
)

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.

Parameters:
mode Calling mode (initial, normal, exit)
parm User parameter (not used)
msg The message to be output

char* QPD_msgText ( void   ) 

Get the message test.

This routine returns the address of the last stored message.

Returns:
The addres of the message text.

Referenced by QPD_dispCmndConf(), and QPD_dispLimData().

unsigned QPD_readDiag ( char *  fName,
QPD_optns  optns 
)

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.

Parameters:
fName The name of the file to be processed
optns Various processing options
Return values:
QPD_SUCCESS Success

References QPD_dispCmndConf(), QPD_dispHeader(), QPD_dispLimData(), QPD_dispModData(), QPD_dispMsgData(), QPD_dispTaskData(), QPD_FLG_FIRST, QPD_FLG_LAST, QPD_FLG_NEW_APID, and QPD_OPT_HEADER.


Generated on Tue Nov 29 20:56:55 2011 by  doxygen 1.5.8