---

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

Constituent: qssp     Tag: linux-gcc

---

         

---

QSSP.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 _QSSP	QSSP
typedef _QSSP_ctx	QSSP_ctx
typedef _QSSP_sample	QSSP_sample
typedef _LSF_datagram	LSF_datagram
typedef _LSF_contribution	LSF_contribution
typedef _LSF_record	LSF_record
Functions
QSSP *	QSSP_alloc (void *must_be_null)
	Allocates and constructs a QSSP handle.
const LSF_contribution *	QSSP_updateAtDatagram (QSSP *qssp, const LSF_datagram *dgm)
	Updates the context at datagram time.
int	QSSP_updateAtContribution (QSSP *qssp, const LSF_contribution *ctb)
	Updates the context at datagram time.
int	QSSP_updateAtRecord (QSSP *qssp, const LSF_record *rec)
	Updates the context at record time.
const QSSP_sample *	QSSP_retrieve (const QSSP *qssp)
	Retrieves the most recent sample, global or incremental that was processed.
void	QSSP_destruct (QSSP *qssp)
	The destructor for a QSSP control structure.
const QSSP_ctx *	QSSP_ctxGet (const QSSP *qssp)
	Locates the statistics context (meta-data).
int	QSSP_sizeof (void *must_be_null)
	Returns the size, in bytes, of a QSS control structure.
QSSP *	QSSP_construct (QSSP *qssp, void *must_be_null)
	The constructor for a QSSP control structure.

---

Detailed Description

Interface to the Science Statistics for Physics datagrams.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QSSP.h,v 1.1.1.1 2008/04/02 01:19:26 russell Exp $

---

Function Documentation

QSSP* QSSP_alloc (  void *  must_be_null  )

Allocates and constructs a QSSP handle. Returns: Pointer to the allocated handle Parameters: must_be_null  Reserved for future use.

QSSP* QSSP_construct (  QSSP *  qssp, void *  must_be_null )

The constructor for a QSSP control structure. Returns: Pointer to the QSS control structure Parameters: qssp  The control structure to be constructed. If NULL, a control structure will be allocated must_be_null  Reserved for future use.

const QSSP_ctx* QSSP_ctxGet (  const QSSP *  qssp  )

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

void QSSP_destruct (  QSSP *  qssp  )

The destructor for a QSSP control structure. Returns: Pointer to the QSS control structure Parameters: qssp  The control structure to be destructed.

const QSSP_sample* QSSP_retrieve (  const QSSP *  qssp  )

Retrieves the most recent sample, global or incremental that was processed. Returns: Pointer to the sample Parameters: qssp  The statistics context

int QSSP_sizeof (  void *  must_be_null  )

Returns the size, in bytes, of a QSS control structure. Returns: The size, in bytes, of a QSS control structure Parameters: must_be_null  Parameter reserved for future use

int QSSP_updateAtContribution (  QSSP *  qssp, 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: qssp  The statistics context to update. ctb  The statistics contribution

const LSF_contribution* QSSP_updateAtDatagram (  QSSP *  qssp, const LSF_datagram *  dgm )

Updates the context at datagram time. Returns: The contribution to resume processsing at Parameters: qssp  The statistics context to update. dgm  The statistics datagram

int QSSP_updateAtRecord (  QSSP *  qssp, const LSF_record *  rec )

Updates the context at record time. Return values: Non-negative  values indicate are one of the QSSP_type's Negative  values indicate an unsuccessful update Parameters: qssp  The statistics context to update. rec  The statistics record

---