GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> QSEP / V3-5-0 > qsep / sun-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » QSD » source » QSEP » V3-5-0 » src

QDFP_evt.h File Reference

Interface to physics event compression construction/destruction and sizing routines. More...

#include <LDT/BFU.h>

Functions

int QDFP_evtSizeof (unsigned int resource_level, void *prm)
 Returns the size, in bytes, of the handle for updating the standard event meta-information.
void * QDFP_evtConstruct (QDFP_evt *evt, unsigned int resource_level, void *prm, void *ptr)
 Construct (initializes) the handle for updating the standard compressed data context information.
BFU QDFP_evtAUpdate (QDFP_ctx *ctx, QDFP_evt *evt, const unsigned int *src, const unsigned int max, BFU bfu, QSE_ctxUpdateInfo *info)
 Decodes an event packed in the standard fashion.
BFU QDFP_evtBUpdate (QDFP_ctx *ctx, QDFP_evt *evt, const unsigned int *src, const unsigned int max, BFU bfu, QSE_ctxUpdateInfo *info)
 Decodes an event packed in the standard fashion.
BFU QDFP_evtAStd1Decode (QDFP_ctx *ctx, QDFP_evt *evt, const unsigned int *src, const unsigned int max, BFU bfu)
 Decodes an event packed in the standard fashion.
BFU QDFP_evtAStd4Decode (QDFP_ctx *ctx, QDFP_evt *evt, const unsigned int *src, const unsigned int max, BFU bfu)
 Decodes an event packed in the standard fashion.
BFU QDFP_evtBStd4Decode (QDFP_ctx *ctx, QDFP_evt *evt, const unsigned int *src, const unsigned int max, BFU bfu)
 Decodes an event packed in the standard fashion.
BFU QDFP_evtAPed1Decode (QDFP_ctx *ctx, QDFP_evt *evt, const unsigned int *src, const unsigned int max, BFU bfu)
 Decodes an event packed in non-zero suppressed mode.
BFU QDFP_evtAPed4Decode (QDFP_ctx *ctx, QDFP_evt *evt, const unsigned int *src, const unsigned int max, BFU bfu)
 Decodes an event packed in non-zero suppressed mode.
BFU QDFP_evtCUpdate (QDFP_ctx *ctx, QDFP_evt *evt, const unsigned int *src, const unsigned int max, BFU bfu, QSE_ctxUpdateInfo *info)
 Decodes an event packed in the standard fashion.
BFU QDFP_evtCStd1Decode (QDFP_ctx *ctx, QDFP_evt *evt, const unsigned int *src, const unsigned int max, BFU bfu)
 Decodes an event packed in the standard fashion.
BFU QDFP_evtCStd4Decode (QDFP_ctx *ctx, QDFP_evt *evt, const unsigned int *src, const unsigned int max, BFU bfu)
 Decodes an event packed in the standard fashion.
BFU QDFP_evtCPed1Decode (QDFP_ctx *ctx, QDFP_evt *evt, const unsigned int *src, const unsigned int max, BFU bfu)
 Decodes an event packed in non-zero suppressed mode.
BFU QDFP_evtCPed4Decode (QDFP_ctx *ctx, QDFP_evt *evt, const unsigned int *src, const unsigned int max, BFU bfu)
 Decodes an event packed in non-zero suppressed mode.

Detailed Description

Interface to physics event compression construction/destruction and sizing routines.

Author:
JJRussell - russell@slac.stanford.edu

   CVS $Id: QDFP_evt.h,v 1.4 2012/09/22 00:17:20 russell Exp $

Function Documentation

BFU QDFP_evtAPed1Decode ( QDFP_ctx *  ctx,
QDFP_evt *  evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu 
)

Decodes an event packed in non-zero suppressed mode.

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

References _QDFP_evt::acd, _QDFP_ctx::acd, _QDFP_evt::tem, and _QDFP_ctx::tem.

Referenced by QDFP_evtAUpdate(), and QDFP_evtBUpdate().

BFU QDFP_evtAPed4Decode ( QDFP_ctx *  ctx,
QDFP_evt *  evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu 
)

Decodes an event packed in non-zero suppressed mode.

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

References _QDFP_evt::acd, _QDFP_ctx::acd, _QDFP_evt::tem, and _QDFP_ctx::tem.

Referenced by QDFP_evtAUpdate(), and QDFP_evtBUpdate().

BFU QDFP_evtAStd1Decode ( QDFP_ctx *  ctx,
QDFP_evt *  evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu 
)

Decodes an event packed in the standard fashion.

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

References _QDFP_evt::acd, _QDFP_ctx::acd, _QDFP_evt::tem, and _QDFP_ctx::tem.

Referenced by QDFP_evtAUpdate(), and QDFP_evtBUpdate().

BFU QDFP_evtAStd4Decode ( QDFP_ctx *  ctx,
QDFP_evt *  evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu 
)

Decodes an event packed in the standard fashion.

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

References _QDFP_evt::acd, _QDFP_ctx::acd, _QDFP_evt::tem, and _QDFP_ctx::tem.

Referenced by QDFP_evtAUpdate().

BFU QDFP_evtAUpdate ( QDFP_ctx *  ctx,
QDFP_evt *  evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu,
QSE_ctxUpdateInfo *  info 
)

Decodes an event packed in the standard fashion.

Returns:
The updated bit position and current deblocked 32-bit buffer
Parameters:
ctx The compressed data decoding context
evt The 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
info The standard update information block.

References evtUpdate(), QDFP_evtAPed1Decode(), QDFP_evtAPed4Decode(), QDFP_evtAStd1Decode(), QDFP_evtAStd4Decode(), QDFP_evtPed1Repack(), QDFP_evtPed4Repack(), QDFP_evtStd1Repack(), and QDFP_evtStd4Repack().

Referenced by evtA_8_update().

BFU QDFP_evtBStd4Decode ( QDFP_ctx *  ctx,
QDFP_evt *  evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu 
)

Decodes an event packed in the standard fashion.

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

References _QDFP_evt::acd, _QDFP_ctx::acd, _QDFP_evt::tem, and _QDFP_ctx::tem.

Referenced by QDFP_evtBUpdate().

BFU QDFP_evtBUpdate ( QDFP_ctx *  ctx,
QDFP_evt *  evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu,
QSE_ctxUpdateInfo *  info 
)

Decodes an event packed in the standard fashion.

Returns:
The updated bit position and current deblocked 32-bit buffer
Parameters:
ctx The compressed data decoding context
evt The 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
info The standard update information block.

References evtUpdate(), QDFP_evtAPed1Decode(), QDFP_evtAPed4Decode(), QDFP_evtAStd1Decode(), QDFP_evtBStd4Decode(), QDFP_evtPed1Repack(), QDFP_evtPed4Repack(), QDFP_evtStd1Repack(), and QDFP_evtStd4Repack().

Referenced by evtB_8_update().

void* QDFP_evtConstruct ( QDFP_evt *  evt,
unsigned int  resource_level,
void *  prm,
void *  ptr 
)

Construct (initializes) the handle for updating the standard compressed data context information.

Returns:
Pointer to the next allocation adddress (i.e. ptr is advanced by the number of bytes consumed by this routine
Parameters:
evt The event structure to be initialize.
resource_level The maximum resource level. Attempts to expand event with resources needs above this value will return QSEP_STATUS_K_INSRSC, that is INSUFFICIENT RESOURCES.
prm A run-time set parameter used to stylize the configuration
ptr Memory to allocate the pieces from. This must be guaranteed by the caller to be large enough

References _QDFP_evt::acd, _QDFP_evt::esb, _QDFP_evt::exc, _QDFP_evt::gem, and _QDFP_evt::tem.

Referenced by qsep_dtxEvt_construct().

BFU QDFP_evtCPed1Decode ( QDFP_ctx *  ctx,
QDFP_evt *  evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu 
)

Decodes an event packed in non-zero suppressed mode.

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

References _QDFP_evt::acd, _QDFP_ctx::acd, _QDFP_evt::tem, and _QDFP_ctx::tem.

Referenced by QDFP_evtCUpdate().

BFU QDFP_evtCPed4Decode ( QDFP_ctx *  ctx,
QDFP_evt *  evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu 
)

Decodes an event packed in non-zero suppressed mode.

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

References _QDFP_evt::acd, _QDFP_ctx::acd, _QDFP_evt::tem, and _QDFP_ctx::tem.

Referenced by QDFP_evtCUpdate().

BFU QDFP_evtCStd1Decode ( QDFP_ctx *  ctx,
QDFP_evt *  evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu 
)

Decodes an event packed in the standard fashion.

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

References _QDFP_evt::acd, _QDFP_ctx::acd, _QDFP_evt::tem, and _QDFP_ctx::tem.

Referenced by QDFP_evtCUpdate().

BFU QDFP_evtCStd4Decode ( QDFP_ctx *  ctx,
QDFP_evt *  evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu 
)

Decodes an event packed in the standard fashion.

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

References _QDFP_evt::acd, _QDFP_ctx::acd, _QDFP_evt::tem, and _QDFP_ctx::tem.

Referenced by QDFP_evtCUpdate().

BFU QDFP_evtCUpdate ( QDFP_ctx *  ctx,
QDFP_evt *  evt,
const unsigned int *  src,
const unsigned int  max,
BFU  bfu,
QSE_ctxUpdateInfo *  info 
)

Decodes an event packed in the standard fashion.

Returns:
The updated bit position and current deblocked 32-bit buffer
Parameters:
ctx The compressed data decoding context
evt The 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
info The standard update information block.

References evtUpdate(), QDFP_evtCPed1Decode(), QDFP_evtCPed4Decode(), QDFP_evtCStd1Decode(), QDFP_evtCStd4Decode(), QDFP_evtPed1Repack(), QDFP_evtPed4Repack(), QDFP_evtStd1Repack(), and QDFP_evtStd4Repack().

int QDFP_evtSizeof ( unsigned int  resource_level,
void *  prm 
)

Returns the size, in bytes, of the handle for updating the standard event meta-information.

Returns:
The size, in bytes, of the handle for updating the standard event meta-information
Parameters:
resource_level The maximum resource level. Attempts to expand event with compression levels that use resources beyond this value will return QSEP_STATUS_K_INSRSC that is INSUFFICIENT RESOURCES. This must be a number between 0 and 15. This parameter plus prm must also be passed to QSEP_construct
prm A run-time set parameter used to stylize the configuration. This parameter plus max_level must also be passed to QSEP_construct.

Referenced by QSEP_sizeof().

Generated on Wed Nov 21 21:13:56 2012 by  doxygen 1.5.8