GRBS_pubdefs.h File Reference

Gamma Ray Burst Analysis Code Defines the public interface to and data structures containing the parameters used in simulating gamma ray burst messages. More...

Typedefs
typedef enum _GRBSim_Modes	GRBSim_Modes
	Typedef for enum _GRBSim_Modes.
Enumerations
enum	_GRBSim_Modes {   GRBSIM_MODE_DISABLE = 0,   GRBSIM_MODE_FULL = 1,   GRBSIM_MODE_SUSPECT = 2,   GRBSIM_MODE_DEBUG = 3,   GRBSIM_MODE4 = 4,   GRBSIM_MODE5 = 5 }
	LPA GRB Algorithm Simulation Modes. More...
Functions
int	GRBS_simConfig (void *siu_ctl, unsigned int mode, unsigned int repoint, unsigned int interval)
	Configure for a simulated GRBS detection.
int	GRBS_simDetect (void *siu_ctl, union _FORK_que *que)
int	GRBS_simReset (void *siu_ctl)
	Reset the GRBS simulation.

---

Detailed Description

Gamma Ray Burst Analysis Code Defines the public interface to and data structures containing the parameters used in simulating gamma ray burst messages.

Author:

Sergio Maldonado - smaldona@slac.stanford.edu

    CVS $Id: GRBS_pubdefs.h,v 1.4 2011/03/28 20:28:08 russell Exp $

---

Enumeration Type Documentation

enum _GRBSim_Modes

LPA GRB Algorithm Simulation Modes.

Enumerator:

GRBSIM_MODE_DISABLE	GRB detection simulation disabled
GRBSIM_MODE_FULL	GRB detection simulation mode full
GRBSIM_MODE_SUSPECT	GRB detection mode suspect only
GRBSIM_MODE_DEBUG	GRB detection debug mode
GRBSIM_MODE4	GRB detection mode 4 unused
GRBSIM_MODE5	GRB detection mode 5 unused

---

Function Documentation

int GRBS_simConfig	(	void *	siu_ctl,
		unsigned int	mode,
		unsigned int	repoint,
		unsigned int	interval
	)

Configure for a simulated GRBS detection.

Return values:

	0,Success
	-1,Failure

Parameters:

	siu_ctl	The GRBS algorithm control block
	mode	The GRBS simulation mode
	repoint	The GRBS repoint time
	interval	The interval in seconds between state transitions

References GRBS_STATE_INACTIVE, GRBSIM_MODE_DEBUG, _GRBS_siuCtl::repoint, _GRBS_siuCtl::sim_cntr, _GRBS_siuCtl::sim_mode, _GRBS_siuCtl::sim_state, and _GRBS_siuCtl::sim_time.

int GRBS_simReset

(

void *

siu_ctl

)

Reset the GRBS simulation.

Return values:

	0,Success
	-1,Failure

Parameters:

siu_ctl

The GRBS algorithm control block

References GRBS_reset().