GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LSE / V2-0-1 > lsew / sun-gcc


Interface   Data Structures   File List   Data Fields   Globals  

CDF_dgn_std_cal.h File Reference

Compresssion context for the CAL diagnostic contribution. More...


Typedefs

typedef struct
_CDF_dgn_std_cal 
CDF_dgn_std_cal
typedef struct
_CDF_dgn_std_cal_cfg 
CDF_dgn_std_cal_cfg
typedef struct
_EBF_dirCtbDsc 
EBF_dirCtbDsc
typedef struct
_LSEW_dgmFw 
LSEW_dgmFw

Functions

int CDF_dgn_std_cal_cfg_sizeof (int level)
 Returns the size, in bytes of the DGN compression configuration needed to support the specified level.
int CDF_dgn_std_cal_cfg_construct (CDF_dgn_std_cal_cfg *cfg, int level, void **mem)
 Constructs the CDF_dgnCalCfg compression configuration.
int CDF_dgn_std_cal_sizeof (int level, const CDF_dgn_std_cal_cfg *cfg)
 Returns the size, in bytes of the CAL DGN compression structure needed to support the specified level.
int CDF_dgn_std_cal_construct (CDF_dgn_std_cal *cdf, int level, const CDF_dgn_std_cal_cfg *cfg, const LSEW_dgmFw *dgmFw, void **mem)
 Constructs the CAL standard diagnostic compression context.
unsigned int CDF_dgn_std_cal_compress (CDF_dgn_std_cal *cdf, unsigned int *buf, unsigned int pos)
 Compresses the CAL diagnostic data when data is taken with standard physics triggers.


Detailed Description

Compresssion context for the CAL diagnostic contribution.

Author:
JJRussell - russell@slac.stanford.edu

   CVS $Id: CDF_dgn_std_cal.h,v 1.1 2009/04/30 18:21:08 russell Exp $

Function Documentation

int CDF_dgn_std_cal_cfg_construct ( CDF_dgn_std_cal_cfg *  cfg,
int  level,
void **  mem 
)

Constructs the CDF_dgnCalCfg compression configuration.

Return values:
Status 
Parameters:
cfg Target specific configuration
level The maximum compression level that needs to be supported
mem Pointer to free memory pointer, return as the the updated pointer. If cfg is equal to the current contents of mem, then mem will be advanced by the size of CDF_dgnCfg else this routine will believe that the only the variable allocation of cdf needs to be allocated.

int CDF_dgn_std_cal_cfg_sizeof ( int  level  ) 

Returns the size, in bytes of the DGN compression configuration needed to support the specified level.

Parameters:
level The maximum compression level to support

unsigned int CDF_dgn_std_cal_compress ( CDF_dgn_std_cal *  cdf,
unsigned int *  buf,
unsigned int  pos 
)

Compresses the CAL diagnostic data when data is taken with standard physics triggers.

Returns:
The updated bit index
Parameters:
cdf The CAL diagnostic context
buf The output bit buffer
pos The output bit index
The CAL diagnostic data consists of two pieces

These are encoded in two separate blocks on a per tower basis, that is the trigger information for all towers is encoded first, followed by the log accept data for all towers.

int CDF_dgn_std_cal_construct ( CDF_dgn_std_cal *  cdf,
int  level,
const CDF_dgn_std_cal_cfg *  cfg,
const LSEW_dgmFw dgmFw,
void **  mem 
)

Constructs the CAL standard diagnostic compression context.

Returns:
Status
Parameters:
cdf The CAL standard diagnostic compression context to construct
level The compression level
cfg The CAL standard diagnostic compression configuration information. Currently this is unused, but is provided for future usage if necessary.
dgmFw The datagram framework. This would be used if the compression of the CAL standard diagnostic data needed to store any context information in the datagram header.
mem A pointer to the memory to allocate any variable length structures the CDF_dgn_std_cal context may need. Currently there are none. If this pointer is the same as cdf, the memory pointer is advanced by the size of the CDF_dgn_std_cal structure before allocating any new memory. This routine updates the memory pointer to the next available address.

int CDF_dgn_std_cal_sizeof ( int  level,
const CDF_dgn_std_cal_cfg *  cfg 
)

Returns the size, in bytes of the CAL DGN compression structure needed to support the specified level.

Parameters:
level The maximum compression level to support
cfg Target specific configuration


Generated on Mon Jul 26 13:00:50 2010 by  doxygen 1.5.3