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

Constituent: qse     Tag: linux-gcc

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

QDF_tem.h File Reference

Interface to the TEM decoding routines. More...

#include "LDT/BFU.h"

Include dependency graph for QDF_tem.h:

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


Typedefs

typedef _QDF_temEvt QDF_temEvt
typedef _QDF_temCtx QDF_temCtx
 Typedef for struct _QDF_temCtx.
typedef _QDF_esbEvt QDF_esbEvt
typedef _QDF_gemEvt QDF_gemEvt
typedef _QDF_exc QDF_exc
typedef _QSE_ctx QSE_ctx

Functions

int QDF_temCtxSizeof (unsigned int level, void *prm)
 Returns the size, in bytes of the TEM decoding context needed to support the specified compression level.
QDF_temCtx * QDF_temCtxConstruct (QDF_temCtx *ctx, unsigned int level, void *prm, const QSE_ctx *qse, void *ptr)
 Constructs (initializes) the specified TEM decoding context structure.
int QDF_temEvtSizeof (unsigned int level, void *prm)
 Returns the size, in bytes of QDF_tem event needed to support the specified compression level.
QDF_temEvt * QDF_temEvtConstruct (QDF_temEvt *evt, unsigned int level, void *prm, void *ptr, QDF_exc *exc, QDF_esbEvt *esb, QDF_gemEvt *gem)
 Constructs (initializes) the specified TEM event structure.

Detailed Description

Interface to the TEM decoding routines.

Author:
JJRussell - russell@slac.stanford.edu
   CVS $Id: QDF_tem.h,v 1.1 2006/11/10 22:35:48 russell Exp $

Function Documentation

QDF_temCtx* QDF_temCtxConstruct (  QDF_temCtx *  ctx,
unsigned int  level,
void *  prm,
const QSE_ctx *  qse,
void *  ptr
) 
 

Constructs (initializes) the specified TEM decoding context structure.

Returns:
Pointer to the context structure to construct
Parameters:
ctx The context structure to construct.
level The maximum level of compression that will be supported.
prm Additional configuation parameter, unused as of now
qse Pointer to the public/generic QSE context parameter
ptr Pointer to the memory pool to carve the various pieces from. It assumed that the user call QDF_temCtxSizeof to determine the necessary size.

int QDF_temCtxSizeof (  unsigned int  level,
void *  prm
) 
 

Returns the size, in bytes of the TEM decoding context needed to support the specified compression level.

Returns:
The size, in bytes, of the TEM decoding context
Parameters:
level The maximum level of compression that needs to be supported
prm Additional configuation parameter, unused as of now

QDF_temEvt* QDF_temEvtConstruct (  QDF_temEvt *  evt,
unsigned int  level,
void *  prm,
void *  ptr,
QDF_exc *  exc,
QDF_esbEvt *  esb,
QDF_gemEvt *  gem
) 
 

Constructs (initializes) the specified TEM event structure.

Returns:
Pointer to the context structure to construct
Parameters:
evt The TEM event structure to construct.
level The maximum level of compression that will be supported.
prm Additional configuation parameter, unused as of now
ptr The available memory
exc Pointer to the global exception handling context
esb Pointer to the Event Summary Data for this event
gem Pointer to the GEM data for this event

int QDF_temEvtSizeof (  unsigned int  level,
void *  prm
) 
 

Returns the size, in bytes of QDF_tem event needed to support the specified compression level.

Returns:
The size, in bytes, of the TEM event
Parameters:
level The maximum level of compression that needs to be supported
prm Additional configuation parameter, unused as of now

Generated on Wed Jun 25 01:18:00 2008 by  doxygen 1.4.4