GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LSEC / V6-1-0 > lsec / sun-gcc


Interface   Data Structures   File List   Data Fields   Globals  

raw.h File Reference

Definitions for the raw routines. More...

#include <stdio.h>

Typedefs

typedef struct LSEC_raw_ LSEC_raw
 Private structure holding raw data for a contribution.

Functions

void LSEC_addRaw (LSEC_raw *raw, void *src)
 Place the data in the next free slot.
unsigned LSEC_checkRaw (LSEC_raw *raw)
 Check the LSEC_raw structure.
void LSEC_clearRaw (LSEC_raw *raw)
 Clear the LSEC_raw structure.
void LSEC_deleteRaw (LSEC_raw *raw)
 Free memory associated with the LSEC_raw structure.
LSEC_rawLSEC_newRaw (unsigned wcnt, unsigned cap)
 Allocate memory for an LSEC_raw structure.
unsigned char * LSEC_packRaw (LSEC_raw *raw, unsigned char *buf)
 Copy the raw data to the output buffer.
void LSEC_reportRaw (LSEC_raw *raw, FILE *fp)
 Produce a formatted ASCII summary of the structure.


Detailed Description

Definitions for the raw routines.

Author:
James Swain & Owen Saxton
Id

Function Documentation

void LSEC_addRaw ( LSEC_raw raw,
void *  src 
)

Place the data in the next free slot.

Parameters:
raw Pointer to an allocated, initialised, LSEC_raw structure
src Pointer to the data to be added to this structure

unsigned LSEC_checkRaw ( LSEC_raw raw  ) 

Check the LSEC_raw structure.

Parameters:
raw Pointer to an allocated, initialise, LSEC_raw structure
Return values:
LSEC_SUCCESS If there were no errors filling this structure
LSEC_RAWOVER If there was an attempt to add more entries than this structure can hold

void LSEC_clearRaw ( LSEC_raw raw  ) 

Clear the LSEC_raw structure.

Parameters:
raw Pointer to an allocated, initialised, LSEC_raw structure

void LSEC_deleteRaw ( LSEC_raw raw  ) 

Free memory associated with the LSEC_raw structure.

Parameters:
raw Pointer to an allocated, initialised, LSEC_raw structure

LSEC_raw* LSEC_newRaw ( unsigned  wcnt,
unsigned  cap 
)

Allocate memory for an LSEC_raw structure.

Parameters:
wcnt Number of words in the data stored for each event
cap Capacity of the calibration task, the maximum number of events that can be collected each cycle
Returns:
Pointer to an allocated, initialised, LSEC_raw structure

unsigned char* LSEC_packRaw ( LSEC_raw raw,
unsigned char *  buf 
)

Copy the raw data to the output buffer.

Parameters:
raw Pointer to an allocated, initialised LSEC_raw structure
buf Pointer to the buffer where the context should be placed
Returns:
Pointer to the next output location to be filled.

void LSEC_reportRaw ( LSEC_raw raw,
FILE *  fp 
)

Produce a formatted ASCII summary of the structure.

Parameters:
raw Pointer to an allocated, initialised, LSEC_raw structure
fp Pointer to file to send the report


Generated on Thu Aug 20 14:34:11 2009 by  doxygen 1.5.3