QDF_tem.h File Reference

Interface to the TEM decoding routines. More...

#include <LDT/BFU.h>

Typedefs
typedef struct _QDF_temCache	QDF_temCache
typedef struct _QDF_temEvt	QDF_temEvt
typedef struct _QDF_temCtx	QDF_temCtx
	Typedef for struct _QDF_temCtx.
typedef struct _QDF_esbEvt	QDF_esbEvt
typedef struct _QDF_gemEvt	QDF_gemEvt
typedef struct _QDF_exc	QDF_exc
typedef struct _QSE_ctx	QSE_ctx
Functions
int	QDF_temCtxSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of the TEM decoding context needed to support the specified compression level.
QDF_temCtx *	QDF_temCtxConstruct (QDF_temCtx *ctx, unsigned int level, QDF_temCache *cache, const QSE_ctx *qse, void *ptr)
	Constructs (initializes) the specified TEM decoding context structure.
int	QDF_temEvtSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of QDF_tem event needed to support the specified compression level.
QDF_temEvt *	QDF_temEvtConstruct (QDF_temEvt *evt, unsigned int level, void *prm, void *ptr, QDF_exc *exc, QDF_esbEvt *esb, QDF_gemEvt *gem)
	Constructs (initializes) the specified TEM event structure.

---

Detailed Description

Interface to the TEM decoding routines.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QDF_tem.h,v 1.3 2011/03/27 01:45:43 russell Exp $

---

Function Documentation

QDF_temCtx* QDF_temCtxConstruct	(	QDF_temCtx *	ctx,
		unsigned int	level,
		QDF_temCache *	cache,
		const QSE_ctx *	qse,
		void *	ptr
	)

Constructs (initializes) the specified TEM decoding context structure.

Returns:

Pointer to the context structure to construct

Parameters:

	ctx	The context structure to construct.
	level	The maximum level of compression that will be supported.
	cache	The TEM caches
	qse	Pointer to the public/generic QSE context parameter
	ptr	Pointer to the memory pool to carve the various pieces from. It assumed that the user call QDF_temCtxSizeof to determine the necessary size.

References _QDF_temCtx::cal, _QDF_temCtx::dgn, _QDF_temCtx::err, QDF_calCtxConstruct(), QDF_calCtxSizeof(), QDF_dgnCtxConstruct(), QDF_dgnCtxSizeof(), QDF_errCtxConstruct(), QDF_errCtxSizeof(), QDF_tkrCtxConstruct(), QDF_tkrCtxSizeof(), and _QDF_temCtx::tkr.

int QDF_temCtxSizeof	(	unsigned int	level,
		void *	prm
	)

Returns the size, in bytes of the TEM decoding context needed to support the specified compression level.

Returns:

The size, in bytes, of the TEM decoding context

Parameters:

	level	The maximum level of compression that needs to be supported
	prm	Additional configuation parameter, unused as of now

References QDF_calCtxSizeof(), QDF_dgnCtxSizeof(), QDF_errCtxSizeof(), and QDF_tkrCtxSizeof().

QDF_temEvt* QDF_temEvtConstruct	(	QDF_temEvt *	evt,
		unsigned int	level,
		void *	prm,
		void *	ptr,
		QDF_exc *	exc,
		QDF_esbEvt *	esb,
		QDF_gemEvt *	gem
	)

Constructs (initializes) the specified TEM event structure.

Returns:

Pointer to the context structure to construct

Parameters:

	evt	The TEM event structure to construct.
	level	The maximum level of compression that will be supported.
	prm	Additional configuation parameter, unused as of now
	ptr	The available memory
	exc	Pointer to the global exception handling context
	esb	Pointer to the Event Summary Data for this event
	gem	Pointer to the GEM data for this event

References _QDF_temEvt::cal, _QDF_temEvt::dgn, _QDF_temEvt::err, _QDF_temEvt::esb, QDF_calEvtConstruct(), QDF_calEvtSizeof(), QDF_dgnEvtConstruct(), QDF_dgnEvtSizeof(), QDF_errEvtConstruct(), QDF_errEvtSizeof(), QDF_tkrEvtConstruct(), QDF_tkrEvtSizeof(), and _QDF_temEvt::tkr.

int QDF_temEvtSizeof	(	unsigned int	level,
		void *	prm
	)

Returns the size, in bytes of QDF_tem event needed to support the specified compression level.

Returns:

The size, in bytes, of the TEM event

Parameters:

	level	The maximum level of compression that needs to be supported
	prm	Additional configuation parameter, unused as of now

References QDF_calEvtSizeof(), QDF_dgnEvtSizeof(), QDF_errEvtSizeof(), and QDF_tkrEvtSizeof().