QSE_calUnpack.h File Reference

Defines the interface to the CAL LAT unpacking routine. More...

Functions
int	QSE_calUnpackSizeof (void)
	Returns the size, in bytes, of a QSE_cal.
int	QSE_calUnpackInit (QSE_cal *cal)
	Performs one time initialization of a CAL LAT record.
int	QSE_calUnpack (QSE_cal *cal, const EBF_dir *dir)
	Unpacks the CAL data for the whole LAT.

---

Detailed Description

Defines the interface to the CAL LAT unpacking routine.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: QSE_calUnpack.h,v 1.2 2005/11/18 01:32:31 russell Exp $

---

Function Documentation

int QSE_calUnpack	(	QSE_cal *	cal,
		const EBF_dir *	dir
	)

Unpacks the CAL data for the whole LAT.

Parameters:

	cal	The QSE_cal data structure to fill
	dir	The directory structure for this event; used to locate the CAL data.

The QSE_cal describes an unpacked butnon-calibrated CAL data for the entire LAT.

References _QSE_cal::logCnt, _QSE_cal::logs, _QSE_cal::nosupMap, QSE_CALFLAGS_M_4RNG, QSE_CALFLAGS_M_NOSUPPRESS, QSE_calTwrMask(), QSE_mapMask(), QSE_mapScanR(), _QSE_cal::rngMap, _QSE_cal::twrMap, _QSE_cal::twrs, unpackTower(), and unpackTower4().

int QSE_calUnpackInit

(

QSE_cal *

cal

)

Performs one time initialization of a CAL LAT record.

Returns:

Status, currently always SUCCESS

Parameters:

cal

Pointer to the structure to initialize

This function should be called only once to initialize the record.

int QSE_calUnpackSizeof

(

void

)

Returns the size, in bytes, of a QSE_cal.

Returns:

The size, in bytes, of a QSE_cal.

This function should be called to determine the size of an QSE_cal structure. This allows the calling program to avoid including the structure definition an QSE_cal.

After allocating an QSE_cal structure, the structure should be initialized using QSE_calUnpackInit().