---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LSEP / V1-2-0

Constituent: lsepw     Tag: mv2304

---

         

---

CDFP.h File Reference

Public interface to produce Compressed Data Format. More...

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

Functions
int	CDFP_cfg_sizeof (int level)
	Returns the size, in bytes, of the compression configuration needed to support the specified compression level.
int	CDFP_cfg_construct (CDFP_cfg *cfg, int level)
	Constructs (initializes) the compression configuration for the appropriate level.
int	CDFP_sizeof (int level, void *cfg)
	Returns the size, in bytes, of the compression structure needed to supprot the specified compression level.
int	CDFP_construct (CDFP_ctx *cdfp, int level, const CDFP_cfg *cfg, LSEW_dgmFw *dgmFw, LSEPW *lsepw)
	Constructs (initializes) the compression structure for the appropriate level.
unsigned int *	CDFP_begin_add (CDFP_ctx *cdfp, unsigned int *buf, unsigned int len)
	Begin datagram callback routine.

---

Detailed Description

Public interface to produce Compressed Data Format.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: CDFP.h,v 1.2 2007/02/14 06:23:14 russell Exp $

---

Function Documentation

unsigned int * CDFP_begin_add (  CDFP_ctx *  cdfp, unsigned int *  beg, unsigned int  len32 )

Begin datagram callback routine. Returns: Pointer to the next write location Parameters: cdfp  The Compressed Data Format handle beg  The output buffer len32  The amount of space, in 32-bit words, available in the output buffer

int CDFP_cfg_construct (  CDFP_cfg *  cfg, int  level )

Constructs (initializes) the compression configuration for the appropriate level. Returns: Status Parameters: cfg  The compression configuratin to initialize level  The maximum compression level that needs supporting Warning: It is assumed that the caller has used CDFP_cfg_sizeof to determine the amount of storage that is needed and, thus, has assured that the cfg structure is adequately sized.

int CDFP_cfg_sizeof (  int  level  )

Returns the size, in bytes, of the compression configuration needed to support the specified compression level. Returns: The size, in bytes, of the compression configuration Parameters: level  The maximum compression level to support

int CDFP_construct (  CDFP_ctx *  cdfp, int  level, const CDFP_cfg *  cfg, LSEW_dgmFw *  dgmFw, LSEPW *  lsepw )

Constructs (initializes) the compression structure for the appropriate level. Returns: Status Parameters: cdfp  The compression context to initialize level  The maximum compression level that needs supporting cfg  Target specific configuration parameter dgmFw  The datagram framework handle lsepw  The generic LSEPW services Warning: It is assumed that the called has used CDFP_sizeof to determine the amount of storage that is needed and, thus, has assured that the cmp structure is adequately sized.

int CDFP_sizeof (  int  level, void *  cfg )

Returns the size, in bytes, of the compression structure needed to supprot the specified compression level. Returns: The size, in bytes, of the compression structure Parameters: level  The maximum compression level to support cfg  Level specific configuration parameter

---