---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > QSSP / V1-0-0

Constituent: qssp     Tag: linux-gcc

---

         

---

QSTD.h File Reference

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

This graph shows which files directly or indirectly include this file:

Typedefs
typedef _QSTD	QSTD
typedef _QSTD_ctx	QSTD_ctx
typedef _LSF_datagram	LSF_datagram
typedef _LSF_contribution	LSF_contribution
typedef _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.

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.

const QSTD_ctx* QSTD_ctxGet (  const QSTD *  qstd  )

Locates the statistics context (meta-data). Parameters: qstd  The statistics context

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.

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

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

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

---