---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > GRBP / V1-0-1

Constituent: grbpsiu     Tag: linux-gcc

---

         

---

GRBP_photonList.h File Reference

Routines to manage the input photons in a circular list. More...

#include "wrap.h"
#include "GRBP_photon.h"

Include dependency graph for GRBP_photonList.h:

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

Data Structures
struct	_GRBP_photonList
	Defines a circular list of photons. More...
Defines
#define	report_photon_new(_pointer, _lid, _energy, _time, _dx, _dy, _dz)
Typedefs
typedef _GRBP_DB_photonList	GRBP_DB_photonList
typedef _GRBP_photonList	GRBP_photonList
Functions
int	GRBP_photonListSizeof (int count)
	Returns the size, in bytes, of the memory needed to hold the variable sized portion of a GRBP_photonList.
unsigned char *	GRBP_photonListConstruct (GRBP_photonList *photonList, const GRBP_DB_photonList *cfg, unsigned char *ptr)
	Constructs a photon list with count photons.
static __inline const GRBP_photon *	GRBP__photonListAdd (GRBP_photonList *photonList, unsigned int lid, double time, double energy, double dx, double dy, double dz)
	Allocates space for and adds a photon with the specified parameters to the photon list.
void	GRBP_photonListReset (GRBP_photonList *photonList)
	Resets the specified photon list to the empty state.

---

Detailed Description

Routines to manage the input photons in a circular list.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: GRBP_photonList.h,v 1.2 2007/08/02 17:25:00 russell Exp $

---

Function Documentation

static __inline const GRBP_photon * GRBP__photonListAdd (  GRBP_photonList *  photonList, unsigned int  lid, double  time, double  energy, double  dx, double  dy, double  dz )  [static]

Allocates space for and adds a photon with the specified parameters to the photon list. Parameters: photonList  The list of photons to add the new photon to lid  The photon's local index. This is the count of photons received time  The time associated with the photon energy  The energy, in Mev, of the photon dx  The x direction cosine dy  The y direction cosine dz  The y direction cosine

unsigned char * GRBP_photonListConstruct (  GRBP_photonList *  photonList, const GRBP_DB_photonList *  cfg, unsigned char *  ptr )

Constructs a photon list with count photons. Returns: A pointer to the next available memory location after allocating space to count photons. Parameters: photonList  The target photon list to construct cfg  The photon list configuration ptr  The current memory pointer. Memory for the storage of the photons will be carved from here. Note that it is assumed the user has called GRBP_photonListSizeof to properly size and then allocate enough memory Warning: This routine assumes that the control structure, photonList has already been allocated.

void GRBP_photonListReset (  GRBP_photonList *  photonList  )

Resets the specified photon list to the empty state. Parameters: photonList  The photon list to reset This function is generally used at startup and to clear the context after a GRB has been closed out.

int GRBP_photonListSizeof (  int  count  )

Returns the size, in bytes, of the memory needed to hold the variable sized portion of a GRBP_photonList. Returns: The size, in bytes, of the memory needed to hold the variable sized portion of a GRBP_photonList. Parameters: count  The number of photons this list will support Warning: This routine does not allocate space for the fixed portion of the GRBP_photonList structure.

---