GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > QPD / V1-0-0

Constituent: qpd     Tag: sun-gcc


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"

Include dependency graph for QPD.h:

This graph shows which files directly or indirectly include this file:


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 }
 Processing options. More...

Functions

void QPD_dispHeader (int flags, CCSDS_telemetry *pkt)
 Display a line of packet header data.
void QPD_dispCmndConf (QPD_flags flags, unsigned secs, ITC_CmdConfirm_Tlm *pkt)
void QPD_dispLimData (QPD_flags flags, unsigned secs, LIM_State_Tlm *pkt)
void QPD_dispModData (QPD_flags flags, unsigned secs, LCM_LLCMMODLIST_Tlm *pkt)
void QPD_dispTaskData (QPD_flags flags, unsigned secs, LCM_LLCMTASKLIST_Tlm *pkt)
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.1.1.1 2008/04/04 19:24:22 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.


Function Documentation

void QPD_dispHeader int  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:
flags The packet flags.
pkt The packet header to be displayed.

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.

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.

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


Generated on Tue Apr 15 01:16:23 2008 by  doxygen 1.4.4