EDR_errUnpack.h File Reference

Defines the interface to the ERR LAT unpacking routines. More...

Functions
int	EDR_errUnpack (EDR_err *err, const EBF_dir *dir, unsigned int map)
	Unpacks the error records for the components specified by map of TEMs.
int	EDR_errUnpackInit (EDR_err *err)
	One-time initialization an EDR_err structure.
int	EDR_errUnpackSizeof (void)
	Returns the size, in bytes, of a ERR LAT record.
void	EDR_errUnpackReset (EDR_err *err)
	Resets the EDR_err structure, preparing it for a new event.

---

Detailed Description

Defines the interface to the ERR LAT unpacking routines.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: EDR_errUnpack.h,v 1.1 2009/04/29 19:47:10 russell Exp $

---

Function Documentation

int EDR_errUnpack	(	EDR_err *	err,
		const EBF_dir *	dir,
		unsigned int	map
	)

Unpacks the error records for the components specified by map of TEMs.

Returns:

A bit mask of the CAL and TKR contributions that are seriously flawed, that is, one should not trust the unpacking.

Parameters:

	err	The error context block to compose
	dir	The target directory structure
	map	The map of components to unpacke

References _EBF_dir::auxs, _EDR_err::bad_ids, _EBF_errTemTimeout::bf, _EBF_errTemSummary::bf, _EDR_err::blk_ids, _EBF_errTemTimeout_bf::cal, _EBF_errTemSummary_bf::cal, _EDR_errStatus::ci, _EDR_errTem::cnt, _EDR_err::ct_ids, _EBF_dirCtbDsc::ctb, _EBF_dir::ctbs, _EBF_dirRedux::dgn_ids, EBF__ctbSequence(), EBF__ctbSize(), EBF__dirCtbTkrLocate(), EBF__errLocate(), EBF_CID_K_GEM, EDR__errStatusIsAbort(), EDR_ERR_COMPONENT_K_CAL, EDR_ERR_COMPONENT_K_TKR, edr_err_tem_parse(), _EBF_dirRedux::err_ids, _EDR_errTem::esum, _EDR_errTemTimeout::msg, _EDR_errTemSummary::msg, _EDR_err::pe_ids, _EBF_errTemSummary_bf::phase, _EBF_dir::redux, _EDR_err::sequence, _EDR_errStatus::si, _EDR_err::tem_ids, _EDR_err::tems, _EDR_errTem::timeout, _EBF_errTemSummary_bf::timeout, _EBF_errTemTimeout_bf::tkr, _EBF_errTemSummary_bf::tkr, _EBF_dirAuxDsc::tkrLen, and _EDR_err::to_ids.

int EDR_errUnpackInit

(

EDR_err *

err

)

One-time initialization an EDR_err structure.

Returns:

0, always

Parameters:

err

The EDR_err structure to initialize

References _EDR_err::tem_ids, and _EDR_err::tems.

Referenced by initIxbObjTbl().

void EDR_errUnpackReset

(

EDR_err *

err

)

Resets the EDR_err structure, preparing it for a new event.

Parameters:

err

The EDR_err structure to reset

References _EDR_err::tem_ids.

Referenced by initIxbObjTbl().

int EDR_errUnpackSizeof

(

void

)

Returns the size, in bytes, of a ERR LAT record.

Returns:

The size, in bytes, of a ERR LAT record.

This function should be called to determine the size of an EDR_err structure. This allows the calling program to avoid including the structure definition an EDR_err.

After allocating an EDR_err structure, the structure should be initialized using EDR_errUnpackInit().