---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > QSE / V1-5-3

Constituent: qse     Tag: linux-gcc

---

         

---

QDF_tkr.h File Reference

Interface to the TKR decoding routines. More...

#include "LDT/BFU.h"

Include dependency graph for QDF_tkr.h:

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

Typedefs
typedef _QDF_tkrEvt	QDF_tkrEvt
typedef _QDF_tkrCtx	QDF_tkrCtx
typedef _QDF_esbEvt	QDF_esbEvt
typedef _QDF_gemEvt	QDF_gemEvt
typedef _QSE_ctx	QSE_ctx
typedef _QDF_exc	QDF_exc
Functions
int	QDF_tkrCtxSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of the TKR decoding context needed to support the specified compression level.
QDF_tkrCtx *	QDF_tkrCtxConstruct (QDF_tkrCtx *ctx, unsigned int level, void *prm, const QSE_ctx *qse)
	Constructs (initializes) the specified TKR decoding context structure.
int	QDF_tkrEvtSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of QDF_tkr event needed to support the specified compression level.
QDF_tkrEvt *	QDF_tkrEvtConstruct (QDF_tkrEvt *evt, unsigned int level, void *prm, QDF_exc *exc, QDF_esbEvt *esb, QDF_gemEvt *gem)
	Constructs (initializes) the specified TKR event structure.
BFU	QDF_tkrStdDecode (QDF_tkrCtx *ctx, QDF_tkrEvt *tkr, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the TKR.
BFU	QDF_tkrPedDecode (QDF_tkrCtx *ctx, QDF_tkrEvt *tkr, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the TKR.

---

Detailed Description

Interface to the TKR decoding routines.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QDF_tkr.h,v 1.1 2006/11/10 22:35:49 russell Exp $

---

Function Documentation

QDF_tkrCtx* QDF_tkrCtxConstruct (  QDF_tkrCtx *  ctx, unsigned int  level, void *  prm, const QSE_ctx *  qse )

Constructs (initializes) the specified TKR 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

int QDF_tkrCtxSizeof (  unsigned int  level, void *  prm )

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

QDF_tkrEvt* QDF_tkrEvtConstruct (  QDF_tkrEvt *  evt, unsigned int  level, void *  prm, QDF_exc *  exc, QDF_esbEvt *  esb, QDF_gemEvt *  gem )

Constructs (initializes) the specified TKR event structure. Returns: Pointer to the context structure to construct Parameters: evt  The TKR event structure to construct. level  The maximum level of compression that will be supported. prm  Additional configuation parameter, unused as of now 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_tkrEvtSizeof (  unsigned int  level, void *  prm )

Returns the size, in bytes of QDF_tkr event needed to support the specified compression level. Returns: The size, in bytes, of the TKR event Parameters: level  The maximum level of compression that needs to be supported prm  Additional configuation parameter, unused as of now

BFU QDF_tkrPedDecode (  QDF_tkrCtx *  ctx, QDF_tkrEvt *  evt, const unsigned int *  src, const unsigned int  max, BFU  bfu )

Decodes the TKR. Returns: The updated bit position and current deblocked 32-bit buffer Parameters: ctx  The TKR compressed data decoding context evt  The TKR event block to fill in src  The data source, i.e. the bit stream max  The maximum bit position bfu  The current bit position and temporary buffer

BFU QDF_tkrStdDecode (  QDF_tkrCtx *  ctx, QDF_tkrEvt *  evt, const unsigned int *  src, const unsigned int  max, BFU  bfu )

Decodes the TKR. Returns: The updated bit position and current deblocked 32-bit buffer Parameters: ctx  The TKR compressed data decoding context evt  The TKR event block to fill in src  The data source, i.e. the bit stream max  The maximum bit position bfu  The current bit position and temporary buffer

---