CDF_dgn_ped.h File Reference

Public interface to produce Compressed Data Format for the diagnostic contributions for pedestal events. More...

Functions
int	CDF_dgn_ped_cfg_sizeof (int level)
	Returns the size, in bytes of the DGN compression configuration needed to support the specified level.
int	CDF_dgn_ped_cfg_construct (CDF_dgn_ped_cfg *cfg, int level, void **mem)
	Constructs the CDF_dgn_ped_cfg compression configuration.
int	CDF_dgn_ped_sizeof (int level, const CDF_dgn_ped_cfg *cfg)
	Returns the size, in bytes of the DGN compression structure needed to support the specified level.
int	CDF_dgn_ped_construct (CDF_dgn_ped *cdf, int level, const CDF_dgn_ped_cfg *cfg, const LSEW_dgmFw *dgmFw, void **mem)
	Constructs the CDF_dgn_ped compression context.
unsigned int	CDF_dgn_ped_compress (CDF_dgn_ped *cdf, unsigned int *buf, unsigned int pos, const EBF_dir *dir, const CDF_err *err, const EDR_cal *cal, const EDR_tkr *tkr)
	Compresses the DGN contributions.

---

Detailed Description

Public interface to produce Compressed Data Format for the diagnostic contributions for pedestal events.

Author:

JJRussell - russell@slac.stanford.edu

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

---

Function Documentation

int CDF_dgn_ped_cfg_construct	(	CDF_dgn_ped_cfg *	cfg,
		int	level,
		void **	mem
	)

Constructs the CDF_dgn_ped_cfg 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.

References CDF_dgn_ped_cal_cfg_construct(), and CDF_dgn_ped_tkr_cfg_construct().

Referenced by CDF_dgnCfg_construct().

int CDF_dgn_ped_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

References CDF_dgn_ped_cal_cfg_sizeof(), and CDF_dgn_ped_tkr_cfg_sizeof().

Referenced by CDF_dgnCfg_sizeof().

unsigned int CDF_dgn_ped_compress	(	CDF_dgn_ped *	cdf,
		unsigned int *	buf,
		unsigned int	pos,
		const EBF_dir *	dir,
		const CDF_err *	err,
		const EDR_cal *	cal,
		const EDR_tkr *	tkr
	)

Compresses the DGN contributions.

Returns:

The updated write bit position

Parameters:

	cdf	The DGN compression data formatting handle
	buf	The output buffer
	pos	The position of the next bit to fill
	dir	The directory describing the event to be formatted
	err	The processed error data, valid iff the EBF directory err_ids are non-zero.
	cal	The unpacked CAL data
	tkr	The unpacked TKR data

References _CDF_dgn_ped::cal, CDF_dgn_cal_tkr_nonempty_find(), CDF_dgn_gen_header_compress(), CDF_dgn_ped_cal_compress(), CDF_dgn_ped_cal_prepare(), _CDF_dgn_ped::tkr, and _CDF_err::tkr.

int CDF_dgn_ped_construct	(	CDF_dgn_ped *	cdf,
		int	level,
		const CDF_dgn_ped_cfg *	cfg,
		const LSEW_dgmFw *	dgmFw,
		void **	mem
	)

Constructs the CDF_dgn_ped compression context.

Return values:

Status

Parameters:

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

References _CDF_dgn_ped::cal, CDF_dgn_ped_cal_construct(), and _CDF_dgn_ped::tkr.

Referenced by CDF_dgn_construct().

int CDF_dgn_ped_sizeof	(	int	level,
		const CDF_dgn_ped_cfg *	cfg
	)

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

Parameters:

	level	The maximum compression level to support
	cfg	Target specific configuration

References CDF_dgn_ped_cal_sizeof(), and CDF_dgn_ped_tkr_sizeof().

Referenced by CDF_dgn_sizeof().