GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > QLRA / V0-1-5

Constituent: qlra     Tag: sun-gcc


Interface   Data Structures   File List   Data Fields   Globals  

QLRA.h File Reference

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

#include "LRA/LRA.h"

Include dependency graph for QLRA.h:

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


Typedefs

typedef void(* QLRA_regsCb )(unsigned int secs, LRA_regData *rData, void *parm)
 Callback routines to process LRA data.
typedef void(* QLRA_esrCb )(unsigned int secs, LRA_esrData *rData, void *parm)
typedef void(* QLRA_statsCb )(unsigned int secs, LRA_stats *sData, void *parm)

Functions

void QLRA_dispEsrData (unsigned int secs, LRA_esrData *rData, void *parm)
 Display error and status register data.
void QLRA_dispRegData (unsigned int secs, LRA_regData *rData, void *parm)
 Display register data.
void QLRA_dispStats (unsigned int secs, LRA_stats *sData, void *parm)
 Display statistics data.
unsigned QLRA_readDiag (char *fName, void *parm, QLRA_regsCb regsRtn)
 Read the contents of an LRA packet file.
unsigned QLRA_readSci (char *fName, void *parm, QLRA_regsCb regsRtn, QLRA_esrCb esrRtn, QLRA_statsCb statsRtn)
 Read the contents of an LRA datagram file.

Detailed Description

Public definitions for the register display routines.

Author:
Owen H Saxton
Id
QLRA.h,v 1.1.1.1 2006/11/01 23:58:10 saxton Exp

Function Documentation

void QLRA_dispEsrData unsigned int  secs,
LRA_esrData *  rData,
void *  parm
 

Display error and status register data.

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

Parameters:
secs The time the register data was obtained, in spacecraft units.
rData The register data to be displayed.
parm Options to modify the display.

void QLRA_dispRegData unsigned int  secs,
LRA_regData *  rData,
void *  parm
 

Display register data.

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

Parameters:
secs The time the register data was obtained, in spacecraft units.
rData The register data to be displayed.
parm Options to modify the display.

void QLRA_dispStats unsigned int  secs,
LRA_stats *  sData,
void *  parm
 

Display statistics data.

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

Parameters:
secs The time the data was sent, in spacecraft units.
sData The statistics data to be displayed.
parm Options to modify the display.

unsigned QLRA_readDiag char *  fName,
void *  parm,
QLRA_regsCb  regsRtn
 

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.

Parameters:
fName The name of the file to be processed
parm User parameter to pass to the processing routine.
regsRtn Routine to process a set of register data. May be NULL.
Return values:
QLRA_SUCCESS Success

unsigned QLRA_readSci char *  fName,
void *  parm,
QLRA_regsCb  regsRtn,
QLRA_esrCb  esrRtn,
QLRA_statsCb  statsRtn
 

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.

Parameters:
fName The name of the file to be displayed
parm User parameter to pass to the processing routine.
regsRtn Routine to call when a set of register values is read. Can be NULL.
esrRtn Routine to call when a set of ESR data is read. Can be NULL.
statsRtn Routine to call when a set of statistics data is read. Can be NULL.
Return values:
QLRA_SUCCESS Success


Generated on Wed Dec 5 07:51:34 2007 by  doxygen 1.4.4