GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > QLMC / V0-0-1

Constituent: qlmc     Tag: linux-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » QSD » source » QLMC » V0-0-1 » QLMC

QLMC.h File Reference

Public definitions for the LMC data display routines. More...

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


Typedefs

typedef void(* QLMC_pktCb )(unsigned int secs, char *pkt, int pktL, void *parm)
 Callback routine to process LMC packet data.

Enumerations

enum  {
  QLMC_DOPT_PLAIN = 0x01,
  QLMC_DOPT_NOHDR = 0x02
}
 Miscellaneous definitions. More...

Functions

unsigned QLMC_readDiag (char *fName, void *parm, QLMC_pktCb calRtn, QLMC_pktCb tkrRtn, QLMC_pktCb acdRtn, QLMC_pktCb deadRtn)
 Read the contents of an LMC packet file.
unsigned QLMC_readSci (char *fName, void *parm, QLMC_pktCb calRtn, QLMC_pktCb tkrRtn, QLMC_pktCb acdRtn, QLMC_pktCb deadRtn)
 Read the contents of an LMC datagram file.
void QLMC_dispCalData (unsigned int secs, char *pkt, int pktL, void *parm)
 Display LMC calorimeter data.
void QLMC_dispTkrData (unsigned int secs, char *pkt, int pktL, void *parm)
 Display LMC tracker data.
void QLMC_dispAcdData (unsigned int secs, char *pkt, int pktL, void *parm)
 Display LMC ACD tile data.
void QLMC_dispDeadData (unsigned int secs, char *pkt, int pktL, void *parm)
 Display LMC TEM dead time data.

Detailed Description

Public definitions for the LMC data display routines.

Author:
Owen H Saxton
Id
QLMC.h,v 1.1.1.1 2007/12/11 23:08:20 saxton Exp

Enumeration Type Documentation

anonymous enum
 

Miscellaneous definitions.

Enumerator:
QLMC_DOPT_PLAIN  Do plain display.
QLMC_DOPT_NOHDR  Don't display header line.

Function Documentation

void QLMC_dispAcdData (  unsigned int  secs,
char *  pkt,
int  pktL,
void *  parm
) 
 

Display LMC ACD tile data.

This routine produces a formatted display of the contents of a packet of LMC ACD tile data.

Parameters:
secs The time the register data was obtained, in spacecraft units.
pkt The address of the packet.
pktL The number of bytes in the packet.
parm Options to modify the display.

void QLMC_dispCalData (  unsigned int  secs,
char *  pkt,
int  pktL,
void *  parm
) 
 

Display LMC calorimeter data.

This routine produces a formatted display of the contents of a packet of LMC calorimeter data.

Parameters:
secs The time the register data was obtained, in spacecraft units.
pkt The address of the packet.
pktL The number of bytes in the packet.
parm Options to modify the display.

void QLMC_dispDeadData (  unsigned int  secs,
char *  pkt,
int  pktL,
void *  parm
) 
 

Display LMC TEM dead time data.

This routine produces a formatted display of the contents of a packet of LMC TEM dead time data.

Parameters:
secs The time the register data was obtained, in spacecraft units.
pkt The address of the packet.
pktL The number of bytes in the packet.
parm Options to modify the display.

void QLMC_dispTkrData (  unsigned int  secs,
char *  pkt,
int  pktL,
void *  parm
) 
 

Display LMC tracker data.

This routine produces a formatted display of the contents of a packet of LMC tracker data.

Parameters:
secs The time the register data was obtained, in spacecraft units.
pkt The address of the packet.
pktL The number of bytes in the packet.
parm Options to modify the display.

unsigned QLMC_readDiag (  char *  fName,
void *  parm,
QLMC_pktCb  calRtn,
QLMC_pktCb  tkrRtn,
QLMC_pktCb  acdRtn,
QLMC_pktCb  deadRtn
) 
 

Read the contents of an LMC packet file.

This routine reads a file of LMC 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.
calRtn Routine to call when a packet of LMC calorimeter data is read. Can be NULL.
tkrRtn Routine to call when a packet of LMC tracker data is read. Can be NULL.
acdRtn Routine to call when a packet of LMC ACD tile data is read. Can be NULL.
deadRtn Routine to call when a packet of LMC TEM deadtime data is read. Can be NULL.
Return values:
QLMC_SUCCESS Success

unsigned QLMC_readSci (  char *  fName,
void *  parm,
QLMC_pktCb  calRtn,
QLMC_pktCb  tkrRtn,
QLMC_pktCb  acdRtn,
QLMC_pktCb  deadRtn
) 
 

Read the contents of an LMC datagram file.

This routine reads a file of LMC 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.
calRtn Routine to call when a packet of LMC calorimeter data is read. Can be NULL.
tkrRtn Routine to call when a packet of LMC tracker data is read. Can be NULL.
acdRtn Routine to call when a packet of LMC ACD tile data is read. Can be NULL.
deadRtn Routine to call when a packet of LMC TEM deadtime data is read. Can be NULL.
Return values:
QLMC_SUCCESS Success

Generated on Wed Mar 5 01:28:30 2008 by  doxygen 1.4.4