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

Constituent: qpig     Tag: linux-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » QSD » source » QPIG » V2-0-0 » QPIG

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_V0
 State of the CRU - version 0. More...
struct  _QPIG_pduState_V0
 State of the PDU - version 0. More...
struct  _QPIG_ebmState_V0
 Structure used to record the state of the EBM - version 0. More...
struct  QPIG_dbState_V0
 Structure holding registers configured by PIG_DB - version 0. More...
struct  _QPIG_pwrState_V0
 Structure holding the power registers - version 0. More...
struct  _QPIG_state_V0
 Combination of structures encapsulating the current state of the registers manipulated by PIG - version 0. More...
struct  _QPIG_cruState
 Structure holding the state of the CRU. More...
struct  _QPIG_pduState
 Structure holding the state of the PDU. More...
struct  _QPIG_ebmState
 Structure used to record the state of the EBM. More...
struct  QPIG_dbState
 Structure holding the registers configured by PIG_DB. More...
struct  _QPIG_pwrState
 Structure holding the power registers. More...
struct  _QPIG_state
 Combination of structures encapsulating the current state of the registers manipulated by PIG. More...

Typedefs

typedef _QPIG_cruState_V0 QPIG_cruState_V0
 State of the CRU - version 0.
typedef _QPIG_pduState_V0 QPIG_pduState_V0
 State of the PDU - version 0.
typedef _QPIG_ebmState_V0 QPIG_ebmState_V0
 Structure used to record the state of the EBM - version 0.
typedef QPIG_dbState_V0 QPIG_dbState_V0
 Structure holding registers configured by PIG_DB - version 0.
typedef _QPIG_pwrState_V0 QPIG_pwrState_V0
 Structure holding the power registers - version 0.
typedef _QPIG_state_V0 QPIG_state_V0
 Combination of structures encapsulating the current state of the registers manipulated by PIG - version 0.
typedef _QPIG_cruState QPIG_cruState
 Structure holding the state of the CRU.
typedef _QPIG_pduState QPIG_pduState
 Structure holding the 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 the registers configured by PIG_DB.
typedef _QPIG_pwrState QPIG_pwrState
 Structure holding the power registers.
typedef _QPIG_state QPIG_state
 Combination of structures 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
}
 Detector constants. More...
enum  { QPIG_CURR_VERSION = 1 }
 Current version of the register state data.

Functions

QPIG_state * QPIG_allocState (void)
 Allocate memory for a QPIG_state structure and construct it as such.
QPIG_state * QPIG_constructState (void *buffer)
 Construct a QPIG_state structure in the memory provided.
void QPIG_destructState (QPIG_state *state)
 Release resources associated with the QPIG_state structure.
const unsigned int * QPIG_recoverState (QPIG_state *state, int version, const unsigned int *buf)
 Copy the state information from the buffer.
void QPIG_reportState (unsigned int secs, int version, const QPIG_state *state, FILE *fp)
 Write a formatted ASCII description of the state.
size_t QPIG_sizeofState (void)
 Return the size of the QPIG state structure.

Detailed Description

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

Author:
James Swain & Owen Saxton
Id
state.h,v 1.3 2009/02/20 23:00:15 saxton Exp

Enumeration Type Documentation

anonymous enum
 

Detector constants.

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.

Parameters:
buffer block of memory to use for the QPIG_state structure
Returns:
Pointer to an initialised 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,
int  version,
const unsigned int *  buf
) 
 

Copy the state information from the buffer.

Parameters:
state Pointer to a state structure
version The version of the state data.
buf Pointer to the context data
Returns:
Pointer to the next word in the buffer

void QPIG_reportState (  unsigned int  secs,
int  version,
const QPIG_state *  state,
FILE *  fp
) 
 

Write a formatted ASCII description of the state.

Parameters:
secs The time the state was sent (spacecraft time)
version The version of the state data.
state Pointer to a state 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 hold the structure

Generated on Sat Feb 21 01:13:47 2009 by  doxygen 1.4.4