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

Constituent: qse     Tag: linux-gcc


Interface   Data Structures   File List   Data Fields   Globals  

QDF_acd.h File Reference

Interface to the ACD decoding routines. More...

#include "LDT/BFU.h"

Include dependency graph for QDF_acd.h:

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


Typedefs

typedef _QDF_acdEvt QDF_acdEvt
typedef _QDF_acdCtx QDF_acdCtx
typedef _QDF_esbEvt QDF_esbEvt
typedef _QDF_gemEvt QDF_gemEvt
typedef _QFR_fileCtx QFR_fileCtx
typedef _QSE_ctx QSE_ctx
typedef _QDF_exc QDF_exc
typedef _CDF_acdBdy CDF_acdBdy

Functions

int QDF_acdCtxSizeof (unsigned int level, void *prm)
 Returns the size, in bytes of the ACD decoding context needed to support the specified compression level.
QDF_acdCtxQDF_acdCtxConstruct (QDF_acdCtx *ctx, unsigned int level, void *prm, const QSE_ctx *qse)
 Constructs (initializes) the specified ACD decoding context structure.
int QDF_acdCtxUpdate (QDF_acdCtx *ctx, QFR_fileCtx *qfr, const CDF_acdBdy *bdy)
 Updates the ACD context from the datagram contribution.
int QDF_acdEvtSizeof (unsigned int level, void *prm)
 Returns the size, in bytes of QDF_acd event needed to support the specified compression level.
QDF_acdEvtQDF_acdEvtConstruct (QDF_acdEvt *evt, unsigned int level, void *prm, QDF_exc *exc, QDF_esbEvt *esb, QDF_gemEvt *gem)
 Constructs (initializes) the specified ACD event structure.
BFU QDF_acdStdDecode (QDF_acdCtx *ctx, QDF_acdEvt *evt, const unsigned int *src, unsigned int max, BFU bfu)
 Decodes the ACD.
BFU QDF_acdPedDecode (QDF_acdCtx *ctx, QDF_acdEvt *evt, const unsigned int *src, unsigned int max, BFU bfu)
 Decodes the ACD.

Detailed Description

Interface to the ACD decoding routines.

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

Function Documentation

QDF_acdCtx* QDF_acdCtxConstruct QDF_acdCtx ctx,
unsigned int  level,
void *  prm,
const QSE_ctx qse
 

Constructs (initializes) the specified ACD 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 The generic datagram context

int QDF_acdCtxSizeof unsigned int  level,
void *  prm
 

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

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

int QDF_acdCtxUpdate QDF_acdCtx ctx,
QFR_fileCtx qfr,
const CDF_acdBdy *  bdy
 

Updates the ACD context from the datagram contribution.

Return values:
0,Success 
0x80000001,Pedestal file error, not found
0x80000002,Pedestal file error, checksum does not match
Parameters:
ctx The context to update
qfr The file translation context
bdy The update information

QDF_acdEvt* QDF_acdEvtConstruct QDF_acdEvt evt,
unsigned int  level,
void *  prm,
QDF_exc exc,
QDF_esbEvt esb,
QDF_gemEvt gem
 

Constructs (initializes) the specified ACD event structure.

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

int QDF_acdEvtSizeof unsigned int  level,
void *  prm
 

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

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

BFU QDF_acdPedDecode QDF_acdCtx ctx,
QDF_acdEvt evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu
 

Decodes the ACD.

Returns:
The updated bit position and current deblocked 32-bit buffer
Parameters:
ctx The compressed data decoding context
evt The ACD 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
This routine is a simple dispatcher, extracting the formatting style, then dispatching to the appropriate decoding routine.

BFU QDF_acdStdDecode QDF_acdCtx ctx,
QDF_acdEvt evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu
 

Decodes the ACD.

Returns:
The updated bit position and current deblocked 32-bit buffer
Parameters:
ctx The compressed data decoding context
evt The ACD 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


Generated on Tue Nov 21 01:27:48 2006 by  doxygen 1.4.4