QSSP_ctx.h File Reference

Public defines of the standard Science Statistics Physics context. More...

#include <QSP/QFCP_files.h>
#include <QSD/QSD_ctx.h>

Classes
struct	_QSSP_ctxKeys
	The configuation keys. More...
struct	_QSSP_ctxIds
	The handler and configuration name/identifiers. More...
struct	_QSSP_ctx
	Binds together all the standard meta-information about an event. More...
Typedefs
typedef struct _QFCP_cache	QFCP_cache
typedef struct _QFR_fileCtx	QFR_fileCtx
typedef struct _LSF_contribution	LSF_contribution
typedef struct _QSSP_ctxKeys	QSSP_ctxKeys
	Typedef for struct QSSP_ctxKeys.
typedef struct _QSSP_ctxIds	QSSP_ctxIds
	Typedef for struct _QSSP_ctxIds.
typedef struct _QSSP_ctx	QSSP_ctx
	Typedef for QSSP_ctx.
Functions
const LSF_contribution *	QSSP_ctxUpdateAtDatagram (QSSP_ctx *ctx, const LSF_contribution *ctb, unsigned int hid)
	Updates the context for the datagram's contributions.
void	QSSP_ctxConstruct (QSSP_ctx *ctx, QFCP_cache *cache)
	Construct the QSSP context.

---

Detailed Description

Public defines of the standard Science Statistics Physics context.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QSSP_ctx.h,v 1.3 2011/03/29 00:14:57 russell Exp $

---

Function Documentation

void QSSP_ctxConstruct	(	QSSP_ctx *	qssp,
		QFCP_cache *	cache
	)

Construct the QSSP context.

Parameters:

	qssp	The QSSP context to construct
	cache	The (initialized) file cache

References _QSSP_ctx::cache, and _QSSP_ctx::files.

Referenced by QASC_construct(), and QSTD_construct().

const LSF_contribution* QSSP_ctxUpdateAtDatagram	(	QSSP_ctx *	qssp,
		const LSF_contribution *	ctb,
		unsigned int	hid
	)

Updates the context for the datagram's contributions.

Returns:

Pointer to the next contribution

Parameters:

	qssp	The QSSP context handle
	ctb	The datagram's contributions
	hid	The handler identity

This routine processes the contributions that rightfully belong to the datagram. In the other datagrams, these are called the root contributions. For the QSTD datagrams, I rethought this issue and decided that while the root contribution is a good idea, I had implemented incorrectly. What QSTD does is let the update at datagram time consume those contributions it believes rightfully belong to it.

So that the user knows that these have been processed, this routine returns the next contribution after the datagram's contributions.

References _QSSP_efsCtxCtb::bdy, _QSSP_ctx::cache, _QSSP_ctxIds::cfg, _QSSP_ctxKeys::cfg, _QSSP_ctx::dgm, _QSSP_ctx::files, _QSSP_ctxIds::handler, _QSSP_efsCtxCtb::hdr, _QSSP_ctx::id, _QSSP_ctx::key, _QSSP_ctxKeys::master, qssp_unpack_ctx_v0(), qssp_unpack_ctx_v1(), qssp_unpack_ctx_v2(), and _QSSP_ctxKeys::sbs.

Referenced by QASC_updateAtDatagram(), and QSTD_updateAtDatagram().