QLMC.h File Reference

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

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

Classes
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 struct _QLMC_timestamp	QLMC_timestamp
	Sample timestamp.
typedef struct _QLMC_calCount	QLMC_calCount
	Calorimeter counter data item.
typedef struct _QLMC_tkrCount	QLMC_tkrCount
	Tracker counter data item.
typedef struct _QLMC_acdCount	QLMC_acdCount
	ACD counter data item.
typedef struct _QLMC_deadCount	QLMC_deadCount
	Deadtime counter data item.
typedef struct _QLMC_calRecord	QLMC_calRecord
	Calorimeter counter record.
typedef struct _QLMC_tkrRecord	QLMC_tkrRecord
	Tracker counter record.
typedef struct _QLMC_acdRecord	QLMC_acdRecord
	ACD counter record.
typedef struct _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.

References _QLMC_acdCount::cnt0, _QLMC_tkrCount::cnt0, _QLMC_calCount::cnt0, _QLMC_deadRecord::cntrs, _QLMC_acdRecord::cntrs, _QLMC_tkrRecord::cntrs, _QLMC_calRecord::cntrs, _QLMC_tkrRecord::pad, _QLMC_calRecord::pad, _QLMC_deadRecord::tenb, and _QLMC_acdCount::tile0.

Referenced by QLMC_readSci().

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

References _QLMC_acdCount::cnt0, _QLMC_tkrCount::cnt0, _QLMC_calCount::cnt0, _QLMC_deadRecord::cntrs, _QLMC_acdRecord::cntrs, _QLMC_tkrRecord::cntrs, _QLMC_calRecord::cntrs, _QLMC_deadCount::dt, _QLMC_acdCount::dt, _QLMC_tkrCount::dt, _QLMC_calCount::dt, _QLMC_tkrRecord::lmsk, _QLMC_calRecord::lmsk, _QLMC_timestamp::secs, _QLMC_deadRecord::tenb, _QLMC_tkrRecord::tenb, _QLMC_calRecord::tenb, _QLMC_acdCount::tile0, _QLMC_deadRecord::ts, _QLMC_acdRecord::ts, _QLMC_tkrRecord::ts, and _QLMC_calRecord::ts.

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

References QLMC_procDgm().