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


Interface   Data Structures   File List   Data Fields   Globals  

CDF_tkr.h File Reference

Public interface to produce Compressed Data Format for the TKR contributor. More...


Functions

int CDF_tkrCfg_sizeof (int level)
 Returns the size, in bytes of the TKR compression configuration needed to support the specified level.
int CDF_tkrCfg_construct (CDF_tkrCfg *cfg, int level, void **mem)
 Constructs the CDF_tkr compression configuration.
int CDF_tkr_sizeof (int level, const CDF_tkrCfg *cfg)
 Returns the size, in bytes of the CAL compression structure needed to support the specified level.
int CDF_tkr_construct (CDF_tkr *cdf, int level, const CDF_tkrCfg *cfg, const LSEW_dgmFw *dgmFw, void **mem)
 Constructs the CDF_cal compression context.
void CDF_tkr_begin (CDF_tkr *cdf, CDF_tkrBdy *bdy)
 Fills int the TKR portion of the datagram contribution used in when decoding an TKR event.
int CDF_tkr_check (CDF_tkr *cdf, const EDR_tkr *tkr)
 Checks that the splits points of all struck layers are consistent with the configuration.


Detailed Description

Public interface to produce Compressed Data Format for the TKR contributor.

Author:
JJRussell - russell@slac.stanford.edu
    CVS $Id: CDF_tkr.h,v 1.3 2009/04/30 18:44:52 russell Exp $


Function Documentation

void CDF_tkr_begin ( CDF_tkr cdf,
CDF_tkrBdy bdy 
)

Fills int the TKR portion of the datagram contribution used in when decoding an TKR event.

Parameters:
cdf The CDF_tkr compress context structure
bdy The CDF_acdBdy structure to fill

int CDF_tkr_check ( CDF_tkr cdf,
const EDR_tkr *  tkr 
)

Checks that the splits points of all struck layers are consistent with the configuration.

Return values:
==0 if successful
< 0 serious structural problems
> 0 a bit mask (low 16 bits) of the towers that can not be compressed.
Parameters:
cdf The CDF_cal compress context structure
tkr The unpacked tracker record

int CDF_tkr_construct ( CDF_tkr cdf,
int  level,
const CDF_tkrCfg *  cfg,
const LSEW_dgmFw dgmFw,
void **  mem 
)

Constructs the CDF_cal compression context.

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

int CDF_tkr_sizeof ( int  level,
const CDF_tkrCfg *  cfg 
)

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

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

int CDF_tkrCfg_construct ( CDF_tkrCfg *  cfg,
int  level,
void **  mem 
)

Constructs the CDF_tkr 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_tkrCfg, else this routine will believe that the only the variable allocation of cdf needs to be allocated.

int CDF_tkrCfg_sizeof ( int  level  ) 

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

Parameters:
level The maximum compression level to support


Generated on Mon Jul 26 12:59:20 2010 by  doxygen 1.5.3