---

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

Constituent: qpig     Tag: sun-gcc

---

         

---

state.h File Reference

Structures that make up the PIG datagram sent to the SSR by PIG_record. More...

#include <unistd.h>
#include <stdio.h>

Include dependency graph for state.h:

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

Data Structures
struct	_QPIG_cruState
	State of the CRU. More...
struct	_QPIG_pduState
	State of the PDU. More...
struct	_QPIG_ebmState
	Structure used to record the state of the EBM. More...
struct	QPIG_dbState
	Structure holding all the registers that are configured by PIG_DB. More...
struct	_QPIG_pwrState
	Structure holding all the power registers that are controlled by PIG. More...
struct	_QPIG_state
	Combination of structure encapsulating the current state of the registers manipulated by PIG. More...
Typedefs
typedef _QPIG_cruState	QPIG_cruState
	State of the CRU.
typedef _QPIG_pduState	QPIG_pduState
	State of the PDU.
typedef _QPIG_ebmState	QPIG_ebmState
	Structure used to record the state of the EBM.
typedef QPIG_dbState	QPIG_dbState
	Structure holding all the registers that are configured by PIG_DB.
typedef _QPIG_pwrState	QPIG_pwrState
	Structure holding all the power registers that are controlled by PIG.
typedef _QPIG_state	QPIG_state
	Combination of structure encapsulating the current state of the registers manipulated by PIG.
Enumerations
enum	{   QPIG_N_PDU = 2,   QPIG_N_TEM = 16,   QPIG_N_CCC = 4,   QPIG_N_TCC = 8,   QPIG_N_FREE = 12 }
Functions
size_t	QPIG_sizeofState (void)
	Return the size of the QPIG state structure.
QPIG_state *	QPIG_constructState (void *buffer)
	Construct a QPIG_state structure in the memory provided.
QPIG_state *	QPIG_allocState (void)
	Allocate memory for a QPIG_state structure and construct it as such.
void	QPIG_destructState (QPIG_state *state)
	Release resources associated with the QPIG_state structure.
void	QPIG_reportState (const QPIG_state *state, FILE *fp)
	Write a formatted ASCII description of the contents of the context to the file fp.
const unsigned int *	QPIG_recoverState (QPIG_state *state, const unsigned int *buf)
	Copy the context information from the buffer.

---

Detailed Description

Structures that make up the PIG datagram sent to the SSR by PIG_record.

Author:

James Swain - jswain@slac.stanford.edu

---

Enumeration Type Documentation

anonymous enum

Enumerator: QPIG_N_PDU  Number of PDUs. QPIG_N_TEM  Number of TEMs. QPIG_N_CCC  Number of CCCs. QPIG_N_TCC  Number of TCCs. QPIG_N_FREE  Number of FREE boards.

---

Function Documentation

QPIG_state* QPIG_allocState (  void   )

Allocate memory for a QPIG_state structure and construct it as such. Returns: Allocated QPIG_state structure

QPIG_state* QPIG_constructState (  void *  buffer  )

Construct a QPIG_state structure in the memory provided. Returns: Pointer to an initialised QPIG_state structure Parameters: buffer  block of memory to use for the QPIG_state structure

void QPIG_destructState (  QPIG_state *  state  )

Release resources associated with the QPIG_state structure. Parameters: state  Pointer to a QPIG_state structure created using QPIG_allocState()

const unsigned int* QPIG_recoverState (  QPIG_state *  state, const unsigned int *  buf )

Copy the context information from the buffer. Parameters: state  Pointer to a state structure buf  Pointer to the context data Returns: Pointer to the next word in the contribution

void QPIG_reportState (  const QPIG_state *  state, FILE *  fp )

Write a formatted ASCII description of the contents of the context to the file fp. Parameters: state  Pointer to a context structure fp  Pointer to the output file

size_t QPIG_sizeofState (  void   )

Return the size of the QPIG state structure. Returns: Size of memory block required to accomodate the QPIG_state structure

---