---

GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> QSEC / V3-1-1 > qsec / linux-gcc

---

         

---

expand.h File Reference

Expansion routines. More...

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

Typedefs
typedef struct QSEC_expansion_	QSEC_expansion
	Declaration of the opaque expansion structure.
Functions
void	QSEC_clearExpansion (QSEC_expansion *exp)
	Clear away any context from a previous cycle.
QSEC_expansion *	QSEC_constructExpansion (void *buffer, unsigned cap)
	Construct a QSEC_expansion structure in a buffer.
void	QSEC_deleteExpansion (QSEC_expansion *exp)
	Free memory previously allocated with a call to QSEC_newExpansion.
unsigned	QSEC_monitorExpansion (QSEC_expansion *exp, unsigned mon)
	Set the monitoring level for the expansion.
QSEC_expansion *	QSEC_newExpansion (unsigned cap)
	Allocate memory for a QSEC_expansion structure and all the substructures.
const unsigned int *	QSEC_recoverUser (QSEC_expansion *exp, const unsigned int *buf)
	Unpack the tables against which the events were encoded.
void	QSEC_reportExpansion (QSEC_expansion *exp, FILE *fp)
	Report the contents of an expansion.
void	QSEC_setFourRange (QSEC_expansion *exp, unsigned rng)
	Set the range for a calibration expansion.
void	QSEC_setMode (QSEC_expansion *exp, unsigned mode)
	Set the calibration mode of an expansion.
size_t	QSEC_sizeofExpansion (unsigned cap)
	Calculate the size of the memory block required to accomodate the expansion structure.

---

Detailed Description

Expansion routines.

Author:

James Swain & Owen Saxton

Id

---

Function Documentation

void QSEC_clearExpansion

(

QSEC_expansion *

exp

)

Clear away any context from a previous cycle.

Parameters:

exp

Pointer to a expansion object

QSEC_expansion* QSEC_constructExpansion	(	void *	buffer,
		unsigned	cap
	)

Construct a QSEC_expansion structure in a buffer.

Parameters:

	cap	Capacity of the decompression, maximum number of events in a single cycle
	buffer	Uninitialised memory large enough to hold the expansion structure

Returns:

Pointer to an initialised expansion structure

void QSEC_deleteExpansion

(

QSEC_expansion *

exp

)

Free memory previously allocated with a call to QSEC_newExpansion.

Parameters:

exp

Pointer to a expansion structure previously created by a call to QSEC_newExpansion

unsigned QSEC_monitorExpansion	(	QSEC_expansion *	exp,
		unsigned	mon
	)

Set the monitoring level for the expansion.

Parameters:

	exp	Pointer to an initialised expansion
	mon	Monitoring level

Returns:

Previous monitoring level

QSEC_expansion* QSEC_newExpansion

(

unsigned

cap

)

Allocate memory for a QSEC_expansion structure and all the substructures.

Parameters:

cap

Capacity of the decompression, maximum number of events in a single cycle

Returns:

Pointer to an allocated, initialise, QSEC_expansion structure

const unsigned int* QSEC_recoverUser	(	QSEC_expansion *	exp,
		const unsigned int *	buf
	)

Unpack the tables against which the events were encoded.

Parameters:

	buf	Pointer to the buffer where the context is held
	exp	Pointer to the structure containing the tables (an expansion)

Returns:

Pointer to the next input location to be read or NULL if there was an error during recovery of User data

void QSEC_reportExpansion	(	QSEC_expansion *	exp,
		FILE *	fp
	)

Report the contents of an expansion.

Parameters:

	exp	Pointer to a expansion object
	fp	Pointer to the destination file

void QSEC_setFourRange	(	QSEC_expansion *	exp,
		unsigned	rng
	)

Set the range for a calibration expansion.

Parameters:

	exp	Pointer to a expansion structure
	rng	Flag indicating 4-range or auto-range

void QSEC_setMode	(	QSEC_expansion *	exp,
		unsigned	mode
	)

Set the calibration mode of an expansion.

Parameters:

	exp	Pointer to a expansion structure
	mode	Type of calibration

size_t QSEC_sizeofExpansion

(

unsigned

cap

)

Calculate the size of the memory block required to accomodate the expansion structure.

Parameters:

cap

Capacity of the decompression, maximum number of events in a single cycle

Returns:

Size of the memory block required to accomodate the expansion structure

---