---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > GRB / V0-1-0

Constituent: grb     Tag: rad750

---

         

---

GRB_ctl.c File Reference

Gamma Ray Burst Analysis Code GRB control interface. More...

#include <stdio.h>
#include <string.h>
#include "PBS/WCT.h"
#include "PBS/WUT.h"
#include "PBS/TOV.h"
#include "MSG/MSG_pubdefs.h"
#include "FBS/FBS_pubrtos.h"
#include "CDM/CDM_pubdefs.h"
#include "GRB/GRB.h"
#include "GRB_write_p.h"
#include "GRB_p.h"
#include "GRB_DB/GRB_DB_schema.h"

Include dependency graph for GRB_ctl.c:

Functions
static WUT_cb_status	GRB_inactiveCb (void *prm, WUT_tmr *wut)
	WUT callback routine.
static WUT_cb_status	GRB_gbmInactiveCb (void *prm, WUT_tmr *wut)
	WUT callback routine.
int	GRB_sizeofAlgCtl (void)
	Returns the size of a algorithm control block.
int	GRB_initAlgCtl (GRB_algCtl *ctl)
	Initializes an algorithm control block.
int	GRB_registerCbs (GRB_algCtl *ctl, GRB_suspectCb suspect, GRB_updateCb update, GRB_confirmCb confirm, GRB_closeoutCb closeout, GRB_attXformJCb xformj, GRB_attXformSCb xforms, GRB_timeLookupCb lktime)
	Registers the posting routines for alert messaging.
int	GRB_reset (GRB_algCtl *ctl)
	Reset the GRB algorithm control block.
int	GRB_loadDbSiu (GRB_algCtl *ctl, unsigned int fid, unsigned int instance)
	Loads the GRB_DB.
int	GRB_buildAlert (GRB_alertMsg *alert, unsigned int class)
	Build a GRB alert message.
int	GRB_handleEvents (GRB_algCtl *ctl, void *dat, unsigned int size, unsigned int prm)
	Processes GRB event summaries from the GRB filter. This is a counting simulation and transitions between detection states based on summary counters.
int	GRB_handleGbmInt (GRB_algCtl *ctl)
	Handle the GBM Interrupt.
int	GRB_handleGbmCalc (GRB_algCtl *ctl, GRB_GbmCalc *dat)
	Handle the GBM Calc Info command.
int	GRB_handleGbmRpt (GRB_algCtl *ctl, GRB_GbmRpt *dat)
	Handle the GBM Repoint command.
int	GRB_handleGbmClose (GRB_algCtl *ctl, GRB_GbmClose *dat)
	Handle the GBM Closeout command.

---

Detailed Description

Gamma Ray Burst Analysis Code GRB control interface.

Author:

Sergio Maldonado - smaldona@slac.stanford.edu

   CVS $Id: GRB_ctl.c,v 1.5 2007/03/16 16:19:41 smaldona Exp $

---

Function Documentation

int GRB_buildAlert (  GRB_alertMsg *  alert, unsigned int  class )

Build a GRB alert message. Parameters: alert  Pointer to alert message class  Burst classification Return values: 0,Success  -1,Failure

static WUT_cb_status GRB_gbmInactiveCb (  void *  prm, WUT_tmr *  wut )  [static]

WUT callback routine. Returns: WUT constant WUT_K_STATE_CHANGE_YES Parameters: prm  User context parameter wut  Wake up timer

int GRB_handleEvents (  GRB_algCtl *  ctl, void *  dat, unsigned int  size, unsigned int  prm )

Processes GRB event summaries from the GRB filter. This is a counting simulation and transitions between detection states based on summary counters. Return values: 0,Success  -1,Failure  Parameters: ctl  The GRB algorithm control block dat  The GRB event summary block size  The GRB event summary size prm  The GRB event summary parameter

int GRB_handleGbmCalc (  GRB_algCtl *  ctl, GRB_GbmCalc *  dat )

Handle the GBM Calc Info command. Return values: 0,Success  -1,Failure

int GRB_handleGbmClose (  GRB_algCtl *  ctl, GRB_GbmClose *  dat )

Handle the GBM Closeout command. Return values: 0,Success  -1,Failure

int GRB_handleGbmInt (  GRB_algCtl *  ctl  )

Handle the GBM Interrupt. Return values: 0,Success  -1,Failure

int GRB_handleGbmRpt (  GRB_algCtl *  ctl, GRB_GbmRpt *  dat )

Handle the GBM Repoint command. Return values: 0,Success  -1,Failure

static WUT_cb_status GRB_inactiveCb (  void *  prm, WUT_tmr *  wut )  [static]

WUT callback routine. Returns: WUT constant WUT_K_STATE_CHANGE_YES Parameters: prm  User context parameter wut  Wake up timer

int GRB_initAlgCtl (  GRB_algCtl *  ctl  )

Initializes an algorithm control block. Return values: 0  Success -1  Failure

int GRB_loadDbSiu (  GRB_algCtl *  ctl, unsigned int  fid, unsigned int  instance )

Loads the GRB_DB. Return values: file  key -1,Failure

int GRB_registerCbs (  GRB_algCtl *  ctl, GRB_suspectCb  suspect, GRB_updateCb  update, GRB_confirmCb  confirm, GRB_closeoutCb  closeout, GRB_attXformJCb  xformj, GRB_attXformSCb  xforms, GRB_timeLookupCb  lktime )

Registers the posting routines for alert messaging. Parameters: ctl  The GRB algorithm control block suspect  The suspect alert post routine update  The update alert post routine confirm  The confirm alert post routine closeout  The closeout alert post routine xformj  The J2000 coordinate transform routine xforms  The spherical coordinate transform routine lktime  The event time lookup routine

int GRB_reset (  GRB_algCtl *  ctl  )

Reset the GRB algorithm control block. Return values: 0,Success  -1,Failure

int GRB_sizeofAlgCtl (  void   )

Returns the size of a algorithm control block. Return values: Size  in bytes of algorithm control block

---