---

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

---

         

---

LSEC_ctx.h File Reference

Context data for charge injection calibration events. More...

#include "LSEC/enums.h"
#include "PBI/Endianness.h"
#include "LSF/LSF_ids.h"
#include "EDS/EBF_ctb.h"

Classes
struct	LSEC_channel
	Channel masking used to collect these events. More...
struct	LSEC_acd
	ACD specific context. More...
struct	LSEC_cal
	Calorimeter specific context. More...
struct	LSEC_tkr
	Tracker specific context. More...
union	LSEC_specific
	Union of the context specific to each calibration mode. More...
struct	LSEC_global
	Context of the calibration common to all modes. More...
struct	LSEC_ctx
	Structure defining the calibration context. More...
struct	LSEC_summary
	Collection of the event builder words and event summary words from the contributors to an event. More...
Defines
#define	LSEC_ID(_id)   (LSF_ID_K_LSEC | (_id))
	Macro applying the LSEC offset to an ID.
Enumerations
enum	{ LSEC_CTX_VERSION = 1 }
	Current context version.
enum	{   LSEC_ID_ETX_FULL = LSEC_ID (1),   LSEC_ID_ETX_ABBREVIATED = LSEC_ID (2),   LSEC_ID_TIM_FULL = LSEC_ID (3),   LSEC_ID_TIM_ABBREVIATED = LSEC_ID (4),   LSEC_ID_CALIB_ACD = LSEC_ID (8),   LSEC_ID_CALIB_ACD_CTX = LSEC_ID (9),   LSEC_ID_CALIB_CAL = LSEC_ID (11),   LSEC_ID_CALIB_CAL_CTX = LSEC_ID (12),   LSEC_ID_CALIB_TKR = LSEC_ID (14),   LSEC_ID_CALIB_TKR_CTX = LSEC_ID (15),   LSEC_ID_CALIB_RAW_EVT = 1,   LSEC_ID_CALIB_CMP_EVT = 2 }
	Contribution ID definitions. More...
enum	{   LSEC_MODE_NONE = 0,   LSEC_MODE_ACD = 1,   LSEC_MODE_CAL = 2,   LSEC_MODE_TKR = 3 }
	Possible calibration modes.
enum	{   LSEC_CHANNEL_SINGLE = 0,   LSEC_CHANNEL_ALL = 1,   LSEC_CHANNEL_PER_FE = 2,   LSEC_CHANNEL_LATC = 3 }
	Flags indicating the meaning of the associated channel number. More...
Functions
unsigned int	LSEC_sizeofCtx32 (unsigned mode)
	Calculate the size of the configuration context.
unsigned int *	LSEC_consignCtx (LSEC_ctx *ctx, unsigned int *buf)
	Copy the context information into the buffer.

---

Detailed Description

Context data for charge injection calibration events.

Author:

James Swain & Owen Saxton

Id

---

Enumeration Type Documentation

anonymous enum

Flags indicating the meaning of the associated channel number.

The exact meanings of these flags are subsystem dependent

anonymous enum

Contribution ID definitions.

Enumerator:

LSEC_ID_ETX_FULL	ID for LSEC full event context contribution, ie a LSE_etxFull.
LSEC_ID_ETX_ABBREVIATED	ID for LSEC abbreviated event context contribution, ie an LSF_etxAbbreviated contribution.
LSEC_ID_TIM_FULL	ID for LSEC full time contribution, ie a LSE_timFull.
LSEC_ID_TIM_ABBREVIATED	ID for LSEP abbreviated time contribution, ie a LSE_timAbbreviated.
LSEC_ID_CALIB_ACD	ID for ACD calibration datagrams.
LSEC_ID_CALIB_ACD_CTX	ID for ACD calibration context contributions.
LSEC_ID_CALIB_CAL	ID for CAL calibration datagrams.
LSEC_ID_CALIB_CAL_CTX	ID for CAL calibration context contributions.
LSEC_ID_CALIB_TKR	ID for TKR calibartion datagrams.
LSEC_ID_CALIB_TKR_CTX	ID for TKR calibration context contributions.
LSEC_ID_CALIB_RAW_EVT	ID for raw event record.
LSEC_ID_CALIB_CMP_EVT	ID for compressed event record.

---

Function Documentation

unsigned int* LSEC_consignCtx	(	LSEC_ctx *	ctx,
		unsigned int *	buf
	)

Copy the context information into the buffer.

Parameters:

	ctx	Pointer to a context structure
	buf	Location to place the context

Returns:

Pointer to the next output location

unsigned int LSEC_sizeofCtx32

(

unsigned

mode

)

Calculate the size of the configuration context.

This routine calculates the number of 32-bit words needed to hold the configuration context for the current calibration mode

Parameters:

mode

One of the LSEC_MODE IDs

Returns:

Size of the configuration context in 32-bit words

---