---

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

---

         

---

CDF_esb.h File Reference

Interface to the routines used to manipulate the Event Summary Block. More...

Typedefs
typedef struct _CDF_esb	CDF_esb
	Typedef for struct _CDF_esb.
typedef struct _CDF_esbCfg	CDF_esbCfg
typedef struct _CDF_cfg	CDF_cfg
typedef struct _EBF_dir	EBF_dir
typedef struct _LSEW_dgmFw	LSEW_dgmFw
	Typedef for struct _LSEW_dgmFw.
Functions
int	CDF_esbCfg_sizeof (int level)
	Returns the size, in bytes of the ESB compression configuration needed to support the specified level.
int	CDF_esbCfg_construct (CDF_esbCfg *cfg, int level, void **mem)
	Constructs the CDF_esbCfg compression configuration.
int	CDF_esb_sizeof (int level, const CDF_esbCfg *cfg)
	Returns the size, in bytes of the ESB compression structure needed to support the specified level.
int	CDF_esb_construct (CDF_esb *cdf, int level, const CDF_esbCfg *cfg, const LSEW_dgmFw *dgmFw, void **mem)
	Constructs the CDF_esb compression context.
unsigned int	CDF_esb_compose (CDF_esb *esb, const CDF_cfg *cfg, const EBF_dir *dir)
	Composes the Event Summary Block for the event defined by the event directory.
unsigned int	CDF_esb_compress (const CDF_esb *esb, unsigned int *buf, unsigned int pos)
	Packs a compressed version of the ESB into the output bit stream.

---

Detailed Description

Interface to the routines used to manipulate the Event Summary Block.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: CDF_esb.h,v 1.2 2007/02/14 04:10:50 russell Exp $

---

Function Documentation

unsigned int CDF_esb_compose	(	CDF_esb *	esb,
		const CDF_cfg *	cfg,
		const EBF_dir *	dir
	)

Composes the Event Summary Block for the event defined by the event directory.

Returns:

A 'representative' copy of the event summary word. The bits that are in common amongst all contributors are the only ones that should be examined.

Parameters:

	esb	The event summary block to compose
	cfg	The static configuration blocks
	dir	The event directory for this event

unsigned int CDF_esb_compress	(	const CDF_esb *	esb,
		unsigned int *	buf,
		unsigned int	pos
	)

Packs a compressed version of the ESB into the output bit stream.

Returns:

The updated bit position offset

Parameters:

	esb	The Event Summary Block to pack
	buf	The output buffer
	pos	The current offset, in bits

int CDF_esb_construct	(	CDF_esb *	cdf,
		int	level,
		const CDF_esbCfg *	cfg,
		const LSEW_dgmFw *	dgmFw,
		void **	mem
	)

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

int CDF_esb_sizeof	(	int	level,
		const CDF_esbCfg *	cfg
	)

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

Parameters:

	level	The maximum compression level to support
	cfg	Target specific configuration

int CDF_esbCfg_construct	(	CDF_esbCfg *	cfg,
		int	level,
		void **	mem
	)

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

int CDF_esbCfg_sizeof

(

int

level

)

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

Parameters:

level

The maximum compression level to support

---