GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > QSE / V1-6-4

Constituent: qse     Tag: linux-gcc


Interface   Data Structures   File List   Data Fields   Globals  

QSE_tkrUnpack.h File Reference

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

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


Functions

static unsigned int __inline QSE__tkrUnpackTowerBitStrips (int tower)
 Constructs the bit mask indicating to unpack the strip data for the specified tower number.
static unsigned int __inline QSE__tkrUnpackTowerBitTots (int tower)
 Constructs the bit mask indicating to unpack the TOT data for the specified tower number.
int QSE_tkrUnpack (QSE_tkr *tlr, const EBF_dir *dir)
 Driver routine to unpack the specified TKR towers.
int QSE_tkrUnpackInit (QSE_tkr *tlr)
 Performs one time initialization of a Track LAT record.
int QSE_tkrUnpackSizeof (void)
 Returns the size, in bytes, of a QSE_tkr.

Detailed Description

Defines the interface to the TKR LAT unpacking routine.

Author:
JJRussell - russell@slac.stanford.edu
    CVS $Id: QSE_tkrUnpack.h,v 1.2 2005/11/18 01:32:32 russell Exp $

These routines unpack the EBF TKR data into the QSE_tkr record. The basic usage outline is
      int   nbytes = QSE_tkrUnpackSizeof ();
      QSE_tkr *tkr = (QSE_tkr *)malloc (nbytes);

      // Initialize the data structure
      QSE_tkrUnpackInit (tkr);

      for_each_event
      {

          EBF_dirCompose     (dir, evt);
          QSE_tkrUnpack (tkr, dir);
      }

Function Documentation

static unsigned int __inline QSE__tkrUnpackTowerBitStrips int  tower  )  [static]
 

Constructs the bit mask indicating to unpack the strip data for the specified tower number.

Returns:
The bit mask for the specified tower
Parameters:
tower The tower number to construct the bit mask for
This is the most modular way of constructing a bit mask for the specified tower. These values can be OR'd together and passed as the tmsk parameter to QSE_tkrUnpack function.

static unsigned int __inline QSE__tkrUnpackTowerBitTots int  tower  )  [static]
 

Constructs the bit mask indicating to unpack the TOT data for the specified tower number.

Returns:
The bit mask for the specified tower
Parameters:
tower The tower number to construct the bit mask for
This is the most modular way of constructing a bit mask for the specified tower. These values can be OR'd together and passed as the tmsk parameter to QSE_tkrUnpack function.

int QSE_tkrUnpack QSE_tkr tkr,
const EBF_dir *  dir
 

Driver routine to unpack the specified TKR towers.

Parameters:
tkr The QSE_tkr record structure to receive the unpacked data
dir The standard directory structure allowing the routine to traverse the LAT event record.
Returns:
Status, currently always success.

int QSE_tkrUnpackInit QSE_tkr tkr  ) 
 

Performs one time initialization of a Track LAT record.

Returns:
Status, currently always SUCCESS
Parameters:
tkr Pointer to the structure to initialize
This function should be called only once to initialize the record. After that, TFC_latReset should be called to reset the structure before each unpack.

int QSE_tkrUnpackSizeof void   ) 
 

Returns the size, in bytes, of a QSE_tkr.

Returns:
The size, in bytes, of a QSE_tkr.
This function should be called to determine the size of an QSE_tkr structure. This allows the calling program to avoid including the structure definition an QSE_tkr.

After allocating an QSE_tkr structure, the structure should be initialized using QSE_tkrUnpackInit().


Generated on Tue Jul 17 04:04:21 2007 by  doxygen 1.4.4