---

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

Constituent: qpig     Tag: linux-gcc

---

         

---

QPIG.h File Reference

Interface to power state updating routines. More...

#include "QPIG/state.h"
#include "LSF/LSF.h"

Include dependency graph for QPIG.h:

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

Typedefs
typedef _QPIG	QPIG
	Data type for QPIG context block.
Functions
QPIG *	QPIG_alloc (void)
	Allocate and construct the QPIG context block.
QPIG *	QPIG_construct (QPIG *qpig, void *prm)
	Construct (initialize) the QPIG context block.
void	QPIG_destruct (QPIG *qpig)
	Destroy the QPIG context block.
unsigned int	QPIG_sizeof (void *prm)
	Return the size, in bytes, of the QPIG context block.
const QPIG_state *	QPIG_stateGet (const QPIG *qpig)
	Return the address of the QPIG register state data.
void	QPIG_updateAtDatagram (QPIG *qpig, const LSF_datagram *dgm)
	Update the register state information in the QPIG context.
int	QPIG_versionGet (const QPIG *qpig)
	Return the version of the QPIG register state data.

---

Detailed Description

Interface to power state updating routines.

Author:

James Swain & Owen Saxton

Id

QPIG.h,v 1.3 2009/02/20 22:57:54 saxton Exp

---

Function Documentation

QPIG* QPIG_alloc (  void   )

Allocate and construct the QPIG context block. Returns: A pointer to the new QPIG context block (context handle)

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

Construct (initialize) the QPIG context block. Parameters: qpig  The block to initialize; if specified as NULL, one will be allocated. prm  A run-time set parameter used to stylize the configuration (not used) Returns: The QPIG context handle

void QPIG_destruct (  QPIG *  qpig  )

Destroy the QPIG context block. Parameters: qpig  The QPIG context handle.

unsigned int QPIG_sizeof (  void *  prm  )

Return the size, in bytes, of the QPIG context block. Parameters: prm  A run-time set parameter used to stylize the configuration Returns: The size, in bytes, of the context block

const QPIG_state* QPIG_stateGet (  const QPIG *  qpig  )

Return the address of the QPIG register state data. This routine is just an accessor to keep the structure of QPIG private. Parameters: qpig  The QPIG context handle Returns: A pointer to the QPIG register state data

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

Update the register state information in the QPIG context. Parameters: qpig  The QPIG context handle dgm  The PIG register state datagram

int QPIG_versionGet (  const QPIG *  qpig  )

Return the version of the QPIG register state data. This routine is just an accessor to keep the structure of QPIG private. Parameters: qpig  The QPIG context handle Returns: The version of the QPIG register state data

---