---

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

Constituent: qpig     Tag: linux-gcc

---

         

---

state.c File Reference

Functions for retrieving and displaying the state information. More...

#include "state_p.h"
#include "LEM/defs.h"
#include "PBS/WCT.h"
#include <string.h>
#include <stdlib.h>
#include <time.h>

Include dependency graph for state.c:

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

Functions for retrieving and displaying the state information.

Author:

James Swain & Owen Saxton

Id

state.c,v 1.4 2009/02/27 19:41:54 saxton Exp

---

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

---