---

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

Constituent: grb     Tag: linux-gcc

---

         

---

GRB_write.h File Reference

Gamma Ray Burst Analysis Code Defines the interface to and data structures used in writing photon events. More...

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

Functions
int	GRB_sizeofWriteCtl (void)
	Returns the size of a GRB write control structure.
int	GRB_initWriteCtl (GRB_writeCtl *ctl)
	Initializes a GRB write control structure.
int	GRB_writePhoton (GRB_writeCtl *ctl, void *ixb, void *buf, int buf_size)
	Writes a photon event to a summary block.
int	GRB_initSummary (void *buf, int buf_size, unsigned int node_id)
	Initializes a photon summary structure.
int	GRB_getPhotonCount (void *buf)
	Returns the current count of photon event in a summary.
int	GRB_getSummarySize (void *buf)
	Returns the total length of the buffer to post.
int	GRB_loadDbEpu (GRB_writeCtl *ctl, unsigned int fid, unsigned int instance)
	Loads the GRB_DB.

---

Detailed Description

Gamma Ray Burst Analysis Code Defines the interface to and data structures used in writing photon events.

Author:

Sergio Maldonado - smaldona@slac.stanford.edu

    CVS $Id: GRB_write.h,v 1.2 2006/07/25 17:59:07 smaldona Exp $

---

Function Documentation

int GRB_getPhotonCount (  void *  buf  )

Returns the current count of photon event in a summary. Return values: Photon  count Parameters: buf  The GRB summary buffer

int GRB_getSummarySize (  void *  buf  )

Returns the total length of the buffer to post. Return values: Size  in bytes of used buffer Parameters: buf  The GRB summary buffer

int GRB_initSummary (  void *  buf, int  buf_size, unsigned int  node_id )

Initializes a photon summary structure. Return values: 0  OK -1,Error  Parameters: buf  The GRB summary buffer buf_size  The GRB summary buffer size node_id  The cpu node ID

int GRB_initWriteCtl (  GRB_writeCtl *  ctl  )

Initializes a GRB write control structure. Return values: 0  OK -1,Error  Parameters: ctl  The control structure pointer

int GRB_loadDbEpu (  GRB_writeCtl *  ctl, unsigned int  fid, unsigned int  instance )

Loads the GRB_DB. Return values: 0,Success  -1,Failure

int GRB_sizeofWriteCtl (  void   )

Returns the size of a GRB write control structure. Return values: Size  in bytes of control structure

int GRB_writePhoton (  GRB_writeCtl *  ctl, void *  ixb, void *  buf, int  buf_size )

Writes a photon event to a summary block. Return values: 0,Not  full 1,Full  -1,Error  Parameters: ctl  The GRB write control block ixb  The EDS information exchange block buf  The GRB summary buffer buf_size  The GRB summary buffer size

---