QSTD.h File Reference

Interface to the Science Statistics for Physics datagrams. More...

Typedefs
typedef struct _QSTD	QSTD
typedef struct _QSTD_ctx	QSTD_ctx
typedef struct _LSF_datagram	LSF_datagram
typedef struct _LSF_contribution	LSF_contribution
typedef struct _LSF_record	LSF_record
Functions
QSTD *	QSTD_alloc (void *must_be_null)
	Allocates and constructs a QSTD handle.
const LSF_contribution *	QSTD_updateAtDatagram (QSTD *qstd, const LSF_datagram *dgm)
	Updates the context at datagram time.
int	QSTD_updateAtContribution (QSTD *qstd, const LSF_contribution *ctb)
	Updates the context at datagram time.
int	QSTD_updateAtRecord (QSTD *qstd, const LSF_record *rec)
	Updates the context at record time.
void	QSTD_destruct (QSTD *qstd)
	The destructor for a QSTD control structure.
const QSTD_ctx *	QSTD_ctxGet (const QSTD *qstd)
	Locates the statistics context (meta-data).
int	QSTD_sizeof (void *must_be_null)
	Returns the size, in bytes, of a QSTD control structure.
QSTD *	QSTD_construct (QSTD *qstd, void *must_be_null)
	The constructor for a QSTD control structure.

---

Detailed Description

Interface to the Science Statistics for Physics datagrams.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QSTD.h,v 1.1 2008/06/10 22:25:45 russell Exp $

---

Function Documentation

QSTD* QSTD_alloc

(

void *

must_be_null

)

Allocates and constructs a QSTD handle.

Returns:

Pointer to the allocated handle

Parameters:

must_be_null

Reserved for future use.

References QSTD_construct().

QSTD* QSTD_construct	(	QSTD *	qstd,
		void *	must_be_null
	)

The constructor for a QSTD control structure.

Returns:

Pointer to the QSTD control structure

Parameters:

	qstd	The control structure to be constructed. If NULL, a control structure will be allocated
	must_be_null	Reserved for future use.

References _QSTD_ctx::com, _QSTD::ctx, _QSTD::cumulative, _QSTD_ctx::cumulative, _QSTD::free, _QSTD::labelsHandlers, QSSP_ctxConstruct(), _QSTD_ctx::qstd, qstd_file_cache_get(), QSTD_labelsHandlersDefGet(), QSTD_sizeof(), QSTD_versionsHandlersDefGet(), and _QSTD::versionsHandlers.

Referenced by QSTD_alloc().

const QSTD_ctx* QSTD_ctxGet

(

const QSTD *

qstd

)

Locates the statistics context (meta-data).

Parameters:

qstd

The statistics context

References _QSTD::ctx.

void QSTD_destruct

(

QSTD *

qstd

)

The destructor for a QSTD control structure.

Returns:

Pointer to the QSS control structure

Parameters:

qstd

The control structure to be destructed.

References _QSTD::free.

int QSTD_sizeof

(

void *

must_be_null

)

Returns the size, in bytes, of a QSTD control structure.

Returns:

The size, in bytes, of a QSTD control structure

Parameters:

must_be_null

Parameter reserved for future use

Referenced by QSTD_construct().

int QSTD_updateAtContribution	(	QSTD *	qstd,
		const LSF_contribution *	ctb
	)

Updates the context at datagram time.

Return values:

	If	have a statistics sample contribution, the number of records in the contribution.
	>0,if	have a record contributor
	=0,if	have the contribution context
	-1,if	unrecognized

Parameters:

	qstd	The statistics context to update.
	ctb	The statistics contribution

const LSF_contribution* QSTD_updateAtDatagram	(	QSTD *	qstd,
		const LSF_datagram *	dgm
	)

Updates the context at datagram time.

Returns:

The contribution to resume processsing at

Parameters:

	qstd	The statistics context to update.
	dgm	The statistics datagram

References _QSTD_ctx::com, _QSTD_ctxVersions::conditions, _QSTD::ctx, _QSTD::cumulative, _QSSP_ctx::dgm, _QSSP_ctx::files, _QSTD_ctx::labels, _QSTD::labelsHandlers, _QSTD_ctxVersions::master, QSSP_ctxUpdateAtDatagram(), QSTD_labelsHandlersResolveFull(), QSTD_VERSION_K_CONDITIONS, QSTD_VERSION_K_SAMPLE, QSTD_versionsGet(), QSTD_versionsHandlersResolveFull(), _QSTD_ctxVersions::sample, _QSTD_ctx::version, _QSTD::versions, and _QSTD::versionsHandlers.

int QSTD_updateAtRecord	(	QSTD *	qstd,
		const LSF_record *	rec
	)

Updates the context at record time.

Return values:

	Non-negative	values indicate are one of the QSTD_type's
	Negative	values indicate an unsuccessful update

Parameters:

	qstd	The statistics context to update.
	rec	The statistics record

References _QSTD::ctx, qstd_sampleV0_decode(), _QSTD_ctxVersions::sample, and _QSTD_ctx::version.