GRBP_windowList.h File Reference

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

Classes
struct	_GRBP_windowList
	The run time description of the collection of localization windows. More...
Typedefs
typedef struct _GRBP_cache	GRBP_cache
typedef struct _GRBP_window	GRBP_window
typedef struct _GRBP_DB_windowList	GRBP_DB_windowList
typedef struct _GRBP_windowList	GRBP_windowList
	Typedef for struct _GRBP_windowList.
Functions
unsigned char *	GRBP_windowListConstruct (GRBP_windowList *windowList, const GRBP_DB_windowList *cfg, unsigned 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.4 2011/03/30 22:11:51 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,
		unsigned 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

References _GRBP_windowList::enabled, _GRBP_windowList::gbm, GRBP_WINDOW_TYPE_K_GBM, GRBP_WINDOW_TYPE_K_LAT, GRBP_windowConstruct(), _GRBP_windowList::lat, _GRBP_window::type, _GRBP_windowList::valid, and _GRBP_windowList::windows.

Referenced by GRBP_clientConstruct().

void * GRBP_windowListGbmCloseout

(

GRBP_windowList *

windowList

)

Actions necessary when a GBM closeout message is received.

Parameters:

windowList

The window list

References _GRBP_windowList::tier1_gbm, and windowListReset().

Referenced by gbmCloseoutHandler().

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.

References _GRBP_windowList::enabled, _GRBP_windowList::gbm, _GRBP_windowList::lat, _GRBP_windowList::tier1_gbm, _GRBP_windowList::tier1_lat, and _GRBP_windowList::tier2.

Referenced by GRBP_windowListReset(), and start().

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.

References GRBP_windowListReady(), _GRBP_windowList::valid, and windowListReset().

Referenced by latReset().

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

References GRBP_windowSizeof().

Referenced by GRBP_clientSizeof().

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

References windowListTier1LatUpdate(), and windowListTier2Update().

Referenced by GRBP_clientProcess().