---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > GRBP / V0-2-0

Constituent: grbpsiu     Tag: sun-gcc

---

         

---

GRBP_windowList.h File Reference

Interface to the routines that manage a list windows. More...

This graph shows which files directly or indirectly include this file:

Data Structures
struct	_GRBP_windowList
	The run time description of the collection of localization windows. More...
Typedefs
typedef _GRBP_cache	GRBP_cache
typedef _GRBP_window	GRBP_window
typedef _GRBP_DB_windowList	GRBP_DB_windowList
typedef _GRBP_windowList	GRBP_windowList
	Typedef for struct _GRBP_windowList.
Functions
unsigned char *	GRBP_windowListConstruct (GRBP_windowList *windowList, const GRBP_DB_windowList *cfg, char *ptr)
	Builds a list windows using the configuration specified by cfg.
void	GRBP_windowListGbmCloseout (GRBP_windowList *windowList)
	Actions necessary when a GBM closeout message is received.
GRBP_window *	GRBP_windowListGbmSeed (GRBP_windowList *windowList, GRBP_cache *cache, double dx, double dy, double dz, double time)
void	GRBP_windowListReady (GRBP_windowList *windowlist)
	Gets the window list ready on a start run.
void	GRBP_windowListReset (GRBP_windowList *windowList)
	Resets the collection of windows.
int	GRBP_windowListSizeof (const GRBP_DB_windowList *cfg)
	Determines the size of the array window contexts specified by cfgs.
GRBP_window *	GRBP_windowListUpdate (GRBP_windowList *windowList, GRBP_cache *cache)
	Updates the state of all the tier 2 windows, then, if not GRB has been declared, updates the state of the tier1 LAT windows.

---

Detailed Description

Interface to the routines that manage a list windows.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: GRBP_windowList.h,v 1.3 2007/08/02 17:25:01 russell Exp $

---

Typedef Documentation

GRBP_windowList

Typedef for struct _GRBP_windowList. In order to efficiently detect GRB's of differing fluences and timescales, multiple windows with their parameters adjusted to match these characteristics are needed. This structure captures a collection of up to 32 such windows. In order to ensure good run-time integrity, this ccllection must be defined at boot time. However, the structure does allow one to enable and disable the windows, allowing one to define a pallet of windows and, at run-time, pick from that pallet.

---

Function Documentation

unsigned char GRBP_windowListConstruct (  GRBP_windowList *  windowList, const GRBP_DB_windowList *  cfg, char *  ptr )

Builds a list windows using the configuration specified by cfg. Parameters: windowList  The list of windows to be constructed cfg  The configurations ptr  The memory block to use to construct the window contexts

void * GRBP_windowListGbmCloseout (  GRBP_windowList *  windowList  )

Actions necessary when a GBM closeout message is received. Parameters: windowList  The window list

void GRBP_windowListReady (  GRBP_windowList *  windowList  )

Gets the window list ready on a start run. Parameters: windowList  The target window list This function is generally called at start up time. It refreshes the the set of lists dividing the enabled lists into tier1 LAT and GBM lists and tier2 list to empty.

void GRBP_windowListReset (  GRBP_windowList *  windowList  )

Resets the collection of windows. Parameters: windowList  The list of windows to be reset This routine is generally called after a GRB has been declared over. It clears out any stale context, readying the windows for the next detection round.

GRBP_windowListSizeof (  const GRBP_DB_windowList *  cfg  )

Determines the size of the array window contexts specified by cfgs. Returns: The size, in bytes, needed to hold all the window contexts Parameters: cfg  The window list configurations

GRBP_window * GRBP_windowListUpdate (  GRBP_windowList *  windowList, GRBP_cache *  cache )

Updates the state of all the tier 2 windows, then, if not GRB has been declared, updates the state of the tier1 LAT windows. Returns: If non-NULL, a pointer to the window declaring a GRB Parameters: windowList  The window list cache  The cache of input photons

---