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_esb.h File Reference

Interface to the ESB (Event Summary Block) decoding routines. More...

#include "LDT/BFU.h"
#include "EDS/EBF_ebw.h"
#include "EDS/EBF_esw.h"
#include "EDS/EBF_ctb.h"

Include dependency graph for QDF_esb.h:

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


Typedefs

typedef _QDF_esbEvt QDF_esbEvt
typedef _QDF_esbCtx QDF_esbCtx
typedef _QDF_exc QDF_exc
typedef _QSE_ctx QSE_ctx

Functions

int QDF_esbCtxSizeof (unsigned int level, void *prm)
 Returns the size, in bytes of the Event Summary Block decoding context needed to support the specified compression level.
QDF_esbCtx * QDF_esbCtxConstruct (QDF_esbCtx *ctx, unsigned int level, void *prm, const QSE_ctx *qse)
 Constructs (initializes) the specified Event Summary Block decoding context structure.
int QDF_esbEvtSizeof (unsigned int level, void *prm)
 Returns the size, in bytes of QDF Event Summary Block needed to support the specified compression level.
QDF_esbEvt * QDF_esbEvtConstruct (QDF_esbEvt *evt, unsigned int level, void *prm, QDF_exc *exc)
 Constructs (initializes) the specified Event Summary Block event structure.
BFU QDF_esbDecode (QDF_esbCtx *ctx, QDF_esbEvt *evt, const unsigned int *src, unsigned int max, BFU bfu)
 Decodes the Event Summary Block.
EBF_ebw QDF_esbEvtEbwGet (const QDF_esbEvt *evt, int cid)
 Returns the event builder word for the specified contributor id.
EBF_esw QDF_esbEvtEswGet (const QDF_esbEvt *evt, int cid)
 Returns the event summary word for the specified contributor id.
EBF_ctbHdr QDF_esbEvtCtbHdrGet (const QDF_esbEvt *evt, int cid)
 Returns the contributor header for the specified contributor id.
unsigned int QDF_esbEvtCtidsGet (const QDF_esbEvt *evt)
unsigned int QDF_esbEvtCidsGet (const QDF_esbEvt *evt)
 Returns a mask of the contributor that are present.
unsigned int QDF_esbEvtSeqGet (const QDF_esbEvt *evt)
 Returns the event sequence number.

Detailed Description

Interface to the ESB (Event Summary Block) decoding routines.

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

Function Documentation

QDF_esbCtx * QDF_esbCtxConstruct (  QDF_esbCtx *  ctx,
unsigned int  level,
void *  prm,
const QSE_ctx *  qse
) 
 

Constructs (initializes) the specified Event Summary Block 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_esbCtxSizeof (  unsigned int  level,
void *  prm
) 
 

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

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

BFU QDF_esbDecode (  QDF_esbCtx *  qdf,
QDF_esbEvt *  esb,
const unsigned int *  src,
unsigned int  max,
BFU  bfu
) 
 

Decodes the Event Summary Block.

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

unsigned int QDF_esbEvtCidsGet (  const QDF_esbEvt *  evt  ) 
 

Returns a mask of the contributor that are present.

Returns:
The mask of contributors that are present
Parameters:
evt The target ESB event structure.
Even if the contributor has no data, the presence of a contributor means an empty contribution should be emitted into the data stream.

QDF_esbCtx * QDF_esbEvtConstruct (  QDF_esbEvt *  evt,
unsigned int  level,
void *  prm,
QDF_exc *  exc
) 
 

Constructs (initializes) the specified Event Summary Block event structure.

Returns:
Pointer to the ESB event structure to construct
Parameters:
evt The ESB 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

EBF_ctbHdr QDF_esbEvtCtbHdrGet (  const QDF_esbEvt *  evt,
int  cid
) 
 

Returns the contributor header for the specified contributor id.

Returns:
The contributor header. Notice that this is returned by value.
Parameters:
evt The target ESB event structure.
cid The contributor ID

EBF_ebw QDF_esbEvtEbwGet (  const QDF_esbEvt *  evt,
int  cid
) 
 

Returns the event builder word for the specified contributor id.

Returns:
Pointer to the ESB event
Parameters:
evt The target ESB event structure.
cid The contributor ID
Note:
The length field of this word cannot be filled in by this utility, since the length is not known until the target contributor is decoded.
The response field of this word cannot be filled in by this utility since it dos not know which contributors are present. Because the response word cannot be filled in, the parity of the LATp portion of this word cannot be computed.
The packet sequence is no longer available. This is property of the physical transport and has been thrown away as being uninteresting. The error field, must be 0 when using this format.

EBF_esw QDF_esbEvtEswGet (  const QDF_esbEvt *  evt,
int  cid
) 
 

Returns the event summary word for the specified contributor id.

Returns:
Pointer to the ESB event
Parameters:
evt The target ESB event structure.
cid The contributor ID

unsigned int QDF_esbEvtSeqGet (  const QDF_esbEvt *  evt  ) 
 

Returns the event sequence number.

Returns:
Pointer to the ESB event
Parameters:
evt The target ESB event structure.

int QDF_esbEvtSizeof (  unsigned int  level,
void *  prm
) 
 

Returns the size, in bytes of QDF Event Summary Block needed to support the specified compression level.

Returns:
The size, in bytes, of the QDF Event Summary Block
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:17:45 2008 by  doxygen 1.4.4