QDFP_ctx.c File Reference

Construction/Deconstruction and sizing routines for the QDFP_ctx structure. More...

#include <QDFP_ctx.h>
#include <QDFP_ctxdef.h>
#include <QSEP_pvtdef.h>
#include <QSE/QDF_acd.h>
#include <QSE/QDF_cal.h>
#include <QSE/QDF_tkr.h>
#include <QSE/QDF_tem.h>
#include <QSE/QDF_esb.h>
#include <QSE/QDF_gem.h>
#include <LSEP/CDFP_ctxCtb.h>
#include <LSF/LSF.h>

Functions
int	QDFP_ctxSizeof (unsigned int resource_level, void *prm)
	Returns the size, in bytes, of the handle for updating the standard event meta-information.
void *	QDFP_ctxConstruct (QDFP_ctx *ctx, unsigned int resource_level, void *prm, const QSEP *qsep, QFR_fileCtx *qfr, void *ptr)
	Construct (initializes) the handle for updating the standard compressed data context information.
int	QDFP_ctxUpdate (QDFP_ctx *qdfp, const QDFP_ctxCtb *ctb, int new)
	Updates the compressed data contribution.

---

Detailed Description

Construction/Deconstruction and sizing routines for the QDFP_ctx structure.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QDFP_ctx.c,v 1.4 2011/03/29 18:49:03 russell Exp $

---

Function Documentation

void* QDFP_ctxConstruct	(	QDFP_ctx *	ctx,
		unsigned int	resource_level,
		void *	prm,
		const QSEP *	qsep,
		QFR_fileCtx *	qfr,
		void *	ptr
	)

Construct (initializes) the handle for updating the standard compressed data context information.

Returns:

Pointer to the next allocation adddress (i.e. ptr is advanced by the number of bytes consumed by this routine

Parameters:

	ctx	The context to be initialize.
	resource_level	The maximum resource level. Attempts to expand event with resources needs above this value will return QSEP_STATUS_K_INSRSC, that is INSUFFICIENT RESOURCES.
	prm	Static configuration options, unused as of yet.
	qsep	The public physics context handle
	qfr	The file resolution handle
	ptr	Memory to allocate the pieces from. This must be guaranteed by the caller to be large enough

References _QDFP_ctx::acd, _QSEP::atx, _QSEP::ctx, _QDFP_ctx::esb, _QDFP_ctx::gem, _QDFP_ctx::qfr, _QDFP_ctx::qsep, and _QDFP_ctx::tem.

Referenced by qsep_dtxCtx_construct().

int QDFP_ctxSizeof	(	unsigned int	resource_level,
		void *	prm
	)

Returns the size, in bytes, of the handle for updating the standard event meta-information.

Returns:

The size, in bytes, of the handle for updating the standard event meta-information

Parameters:

	resource_level	The maximum resource level. Attempts to expand event with compression levels that use resources beyond this value will return QSEP_STATUS_K_INSRSC that is INSUFFICIENT RESOURCES. This must be a number between 0 and 15. This parameter plus prm must also be passed to QSEP_construct
	prm	A run-time set parameter used to stylize the configuration. This parameter plus max_level must also be passed to QSEP_construct.

Referenced by QSEP_sizeof().

int QDFP_ctxUpdate	(	QDFP_ctx *	qdfp,
		const QDFP_ctxCtb *	ctb,
		int	new
	)

Updates the compressed data contribution.

Return values:

	==	0, Successfully handled
	!=	0, Error, this is encoded as a bit mask of the failed operations.

Parameters:

	qdfp	The application specific public context handle
	ctb	The contribution to handle
	new	Flag indicating that new information due to a mode change or a new run may be present.

The information in the contribution is unpacked from its dense representation into a standard, more accessible form.

References _QDFP_ctx::acd, _QDFP_ctxCtb::bdy, _QDFP_ctx::gem, _QDFP_ctxCtb::hdr, _QDFP_ctx::qfr, _QDFP_ctx::tem, _QDFP_ctxBdy::v0, and _QDFP_ctxBdy::v1.

Referenced by cdfUpdate().