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

Constituent: qlmc     Tag: linux-gcc

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

QLMC.h File Reference

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

#include "LMC/LMC_pubdefs.h"
#include "LSF/LSF.h"

Include dependency graph for QLMC.h:

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


Data Structures

struct  _QLMC_timestamp
 Sample timestamp. More...
struct  _QLMC_calCount
 Calorimeter counter data item. More...
struct  _QLMC_tkrCount
 Tracker counter data item. More...
struct  _QLMC_acdCount
 ACD counter data item. More...
struct  _QLMC_deadCount
 Deadtime counter data item. More...
struct  _QLMC_calRecord
 Calorimeter counter record. More...
struct  _QLMC_tkrRecord
 Tracker counter record. More...
struct  _QLMC_acdRecord
 ACD counter record. More...
struct  _QLMC_deadRecord
 Deadtime counter record. More...

Typedefs

typedef _QLMC_timestamp QLMC_timestamp
 Sample timestamp.
typedef _QLMC_calCount QLMC_calCount
 Calorimeter counter data item.
typedef _QLMC_tkrCount QLMC_tkrCount
 Tracker counter data item.
typedef _QLMC_acdCount QLMC_acdCount
 ACD counter data item.
typedef _QLMC_deadCount QLMC_deadCount
 Deadtime counter data item.
typedef _QLMC_calRecord QLMC_calRecord
 Calorimeter counter record.
typedef _QLMC_tkrRecord QLMC_tkrRecord
 Tracker counter record.
typedef _QLMC_acdRecord QLMC_acdRecord
 ACD counter record.
typedef _QLMC_deadRecord QLMC_deadRecord
 Deadtime counter record.
typedef void QLMC_calCB (QLMC_calRecord *recd, int nCntr, void *parm)
 Callback routine to process calorimeter data records.
typedef void QLMC_tkrCB (QLMC_tkrRecord *recd, int nCntr, void *parm)
 Callback routine to process tracker data records.
typedef void QLMC_acdCB (QLMC_acdRecord *recd, int nCntr, void *parm)
 Callback routine to process ACD data records.
typedef void QLMC_deadCB (QLMC_deadRecord *recd, int nCntr, void *parm)
 Callback routine to process deadtime data records.

Functions

void QLMC_procDgm (const LSF_datagram *dgm, void *parm, QLMC_calCB calRtn, QLMC_tkrCB tkrRtn, QLMC_acdCB acdRtn, QLMC_deadCB deadRtn)
 Process a datagram.
unsigned QLMC_readDiag (char *fName, void *parm, QLMC_calCB calRtn, QLMC_tkrCB tkrRtn, QLMC_acdCB acdRtn, QLMC_deadCB deadRtn)
 Read the contents of an LMC packet file.
unsigned QLMC_readSci (char *fName, void *parm, QLMC_calCB calRtn, QLMC_tkrCB tkrRtn, QLMC_acdCB acdRtn, QLMC_deadCB deadRtn)
 Read the contents of an LMC datagram file.

Detailed Description

Public definitions for the LMC data access routines.

Author:
Owen H Saxton
Id
QLMC.h,v 1.4 2008/03/11 21:20:04 saxton Exp

Function Documentation

void QLMC_procDgm (  const LSF_datagram *  dgm,
void *  parm,
QLMC_calCB  calRtn,
QLMC_tkrCB  tkrRtn,
QLMC_acdCB  acdRtn,
QLMC_deadCB  deadRtn
) 
 

Process a datagram.

This routine processes a complete datagram of LMC data, and calls a user-supplied routine for each type of data record present.

Parameters:
dgm The datagram to be processed.
parm User parameter to pass to the processing routine.
calRtn Routine to call for each LMC calorimeter data record in the datagram. Can be NULL.
tkrRtn Routine to call for each LMC tracker data record in the datagram. Can be NULL.
acdRtn Routine to call for each LMC ACD data record in the datagram. Can be NULL.
deadRtn Routine to call for each LMC deadtime data record in the datagram. Can be NULL.

unsigned QLMC_readDiag (  char *  fName,
void *  parm,
QLMC_calCB  calRtn,
QLMC_tkrCB  tkrRtn,
QLMC_acdCB  acdRtn,
QLMC_deadCB  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 user-supplied processing routine for each type of data record found.

Parameters:
fName The name of the file to be processed
parm User parameter to pass to the processing routine.
calRtn Routine to call for each LMC calorimeter data record in the file. Can be NULL.
tkrRtn Routine to call for each LMC tracker data record in the file. Can be NULL.
acdRtn Routine to call for each LMC ACD data record in the file. Can be NULL.
deadRtn Routine to call for each LMC deadtime data record in the file. Can be NULL.
Return values:
QLMC_SUCCESS Success

unsigned QLMC_readSci (  char *  fName,
void *  parm,
QLMC_calCB  calRtn,
QLMC_tkrCB  tkrRtn,
QLMC_acdCB  acdRtn,
QLMC_deadCB  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 record found.

Parameters:
fName The name of the file to be displayed
parm User parameter to pass to the processing routine.
calRtn Routine to call for each LMC calorimeter data record in the file. Can be NULL.
tkrRtn Routine to call for each LMC tracker data record in the file. Can be NULL.
acdRtn Routine to call for each LMC ACD data record in the file. Can be NULL.
deadRtn Routine to call for each LMC deadtime data record in the file. Can be NULL.
Return values:
QLMC_SUCCESS Success

Generated on Thu Mar 13 01:18:23 2008 by  doxygen 1.4.4