GRBS_siu_p.h File Reference

Gamma Ray Burst Analysis Code Private definitions for SIU GRB handling. More...

#include <GRB/GRB_siu.h>
#include <GRB/GRB_latMsg.h>
#include <PBS/WUT.h>
#include <PBS/FORK.h>

Classes
struct	_GRBS_simMsg
	The sim fork message. More...
struct	_GRBS_siuCtl
	The control structure for the GRBS analysis framework. More...
Defines
#define	GRBS_NUM_EVTS_PKT   24
#define	GRBS_SUSPECT_EVT_CNT   1536
#define	GRBS_UPDATE_LO_EVT_CNT   3048
#define	GRBS_UPDATE_HI_EVT_CNT   3288
#define	GRBS_CONFIRM_EVT_CNT   3312
#define	GRBS_CLOSEOUT_EVT_CNT   4608
#define	GRBS_INACTIVE_EVT_CNT   6144
Typedefs
typedef enum _GRBS_States	GRBS_States
	Typedef for enum _GRBS_States.
typedef struct _GRBS_simMsg	GRBS_simMsg
	Typedef for struct _GRBS_simMsg.
typedef struct _GRBS_siuCtl	GRBS_siuCtl
	Typedef for struct _GRBS_siuCtl.
Enumerations
enum	_GRBS_States {   GRBS_STATE_INACTIVE = 0,   GRBS_STATE_SUSPECT = 1,   GRBS_STATE_CONFIRM = 2 }
	LPA GRBS Algorithm Callback Function Types. More...
Functions
void	GRBS_buildAlert (GRB_latAlertMsg *alert, unsigned int class, char ts)
	Build a GRBS alert message.
unsigned int	GRBS_reset (GRBS_siuCtl *siu_ctl)
	Reset the GRBS algorithm control block.

---

Detailed Description

Gamma Ray Burst Analysis Code Private definitions for SIU GRB handling.

Author:

Sergio Maldonado - smaldona@slac.stanford.edu

    CVS $Id: GRBS_siu_p.h,v 1.5 2011/03/28 20:28:09 russell Exp $

---

Define Documentation

#define GRBS_CLOSEOUT_EVT_CNT   4608

Event threshold to trigger a closeout

Referenced by GRBS_handleEvents().

#define GRBS_CONFIRM_EVT_CNT   3312

Event threshold to trigger a confirm

Referenced by GRBS_handleEvents().

#define GRBS_INACTIVE_EVT_CNT   6144

Event threshold to reset inactive

Referenced by GRBS_handleEvents().

#define GRBS_NUM_EVTS_PKT   24

Average number of events in a GRB packet

Referenced by GRBS_handleEvents().

#define GRBS_SUSPECT_EVT_CNT   1536

Event threshold to trigger a suspect

Referenced by GRBS_handleEvents().

#define GRBS_UPDATE_HI_EVT_CNT   3288

Upper event threshold to trigger an update

Referenced by GRBS_handleEvents().

#define GRBS_UPDATE_LO_EVT_CNT   3048

Lower event threshold to trigger an update

---

Enumeration Type Documentation

enum _GRBS_States

LPA GRBS Algorithm Callback Function Types.

Enumerator:

GRBS_STATE_INACTIVE	Inactive or GRBS not detected
GRBS_STATE_SUSPECT	GRBS suspected
GRBS_STATE_CONFIRM	GRBS confirmed

---

Function Documentation

void GRBS_buildAlert	(	GRB_latAlertMsg *	alert,
		unsigned int	class,
		char	ts
	)

Build a GRBS alert message.

Parameters:

	alert	Pointer to alert message
	class	Burst classification
	ts	Timestamp flags

Referenced by GRBS_gbmInactiveCb(), GRBS_handleEvents(), GRBS_handleGbmRpt(), GRBS_inactiveCb(), GRBS_reset(), and GRBS_simForkCb().

int GRBS_reset

(

GRBS_siuCtl *

siu_ctl

)

Reset the GRBS algorithm control block.

Return values:

Status

code

References _GRBS_siuCtl::alert, _GRBS_siuCtl::detect, _GRBS_siuCtl::gbm_wut, GRBS_buildAlert(), GRBS_STATE_INACTIVE, GRBSIM_MODE_DISABLE, _GRBS_siuCtl::ievt, _GRBS_siuCtl::lat_svc, _GRBS_siuCtl::sim_cntr, _GRBS_siuCtl::sim_mode, _GRBS_siuCtl::sim_state, _GRBS_siuCtl::sim_time, _GRBS_siuCtl::sim_wut, _GRBS_siuCtl::started, _GRBS_siuCtl::state, _GRBS_siuCtl::timeout_state, and _GRBS_siuCtl::wut.

Referenced by GRBS_handleStop(), and GRBS_simReset().