---

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

Constituent: qpig     Tag: sun-gcc

---

         

---

QPIG.h File Reference

Interface to power state updating routines. More...

#include "QPIG/state.h"

Include dependency graph for QPIG.h:

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

Functions
QPIG *	QPIG_alloc (void)
	Allocates and constructs the QPIG handle.
void	QPIG_updateAtDatagram (QPIG *qpig, const LSF_datagram *dgm)
	Updates the run oriented information in the event context using the information from the event datagram.
void	QPIG_updateAtContribution (QPIG *qpig, const LSF_contribution *ctb)
	Updates the context based on the contribution.
void	QPIG_destruct (QPIG *qpig)
	Destroy the QPIG handle.
const QPIG_state *	QPIG_appStateGet (const QPIG *qpig)
	Return a pointer to the public QPIG application specific context block.
unsigned int	QPIG_sizeof (void *prm)
	Returns the size, in bytes, of the handle for updating the standard event meta-information.
QPIG *	QPIG_construct (QPIG *qpig, void *prm)
	Construct (initializes) the handle for updating the standard event meta-information.

---

Detailed Description

Interface to power state updating routines.

Author:

jswain@slac.stanford.edu

   CVS $Id: QPIG.h,v 1.1.1.1 2005/12/06 23:37:35 jswain Exp $

---

Function Documentation

QPIG* QPIG_alloc (  void   )

Allocates and constructs the QPIG handle. Returns: A pointer to the allocated and constructed QPIG handle

const QPIG_state* QPIG_appStateGet (  const QPIG *  qpig  )

Return a pointer to the public QPIG application specific context block. Returns: A pointer to the QPIG application specific context block Parameters: qpig  The calibration event handle This routine is just an accessor to keep the structure of QPIG private.

QPIG* QPIG_construct (  QPIG *  qpig, void *  prm )

Construct (initializes) the handle for updating the standard event meta-information. Returns: The QSEP context structure Parameters: qpig  The handle to initialize, if specified as NULL, one will be allocated prm  A run-time set parameter used to stylize the configuration

void QPIG_destruct (  QPIG *  qpig  )

Destroy the QPIG handle. Parameters: qpig  Pointer to the QPIG handle to delete.

unsigned int QPIG_sizeof (  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: prm  A run-time set parameter used to stylize the configuration

void QPIG_updateAtContribution (  QPIG *  qpig, const LSF_contribution *  ctb )

Updates the context based on the contribution. Parameters: qpig  The calibration event handle to update ctb  The contribution

void QPIG_updateAtDatagram (  QPIG *  qpig, const LSF_datagram *  dgm )

Updates the run oriented information in the event context using the information from the event datagram. Parameters: qpig  The calibration event handle dgm  The event datagram Note: The root contribution is opaque to the caller, so QPIG must handle the contributions within the root. There are two strategies one could use Call LSF_scanContribtions and let it parse through them and invoke a user call back routine Do the scan by hand. Initially I have opted for strategy #1, but the second strategy makes detailed error checking easier. For example, if the sequence of the contributions is fixed, it is likely easier to do this when doing the scan by hand.

---