---

GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> EDS / V2-10-1 > ebfio / linux-gcc

---

         

---

EBF_evt.h File Reference

Defines the attributes and data structures relating to an EBF event. More...

#include "EDS/EBF_pkt.h"
#include "EDS/EBF_ctb.h"

Classes
struct	_EBF_evt
	Template of an event as it appears in the LCB ring buffer. More...
Typedefs
typedef struct _EBF_evt	EBF_evt
	Typedef for struct _EBF_evt.
Functions
static __inline EBF_evt *	EBF__evtAdvance (const EBF_evt *evt, int len)
	Returns a pointer to the next event.
static __inline unsigned int	EBF__evtSequence (const EBF_evt *evt)
	Returns the 17 bit event sequence number.

---

Detailed Description

Defines the attributes and data structures relating to an EBF event.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: EBF_evt.h,v 1.3 2005/10/13 22:00:53 russell Exp $

---

Typedef Documentation

EBF_evt

Typedef for struct _EBF_evt.

This gives the template of an event as it appears in the LCB ring buffer as an EBF event header, EBF_ehdr, followed by the first contributor.

---

Function Documentation

static __inline EBF_evt * EBF__evtAdvance	(	const EBF_evt *	evt,
		int	nbytes
	)			[static]

Returns a pointer to the next event.

Returns:

Pointer to the next event

Parameters:

	evt	Pointer to the event
	nbytes	The number of bytes to advance the pointer

Warning:

Note that this routine makes no guarantee that there is a next event. It merely advances the pointer to one past the end of the base event.

One should use this function with caution. In the case of multi-packet events, no integrity checking is done on the packets. The routine simply keeps adding up the size of each packet while the receive status is PACKET_TRUNCATED. It is really meant to be used with a prepared set of data (e.g. from GLEAM, but not directly from the Event Builder Module via the LCB) were integrity is not an issue

static __inline unsigned int EBF__evtSequence

(

const EBF_evt *

evt

)

[static]

Returns the 17 bit event sequence number.

Returns:

The 17 bit event sequence number

Parameters:

evt

Pointer to the event

The event sequence number actually appears in every contributor to the event. This function uses the first contributor (almost always the GEM) and the source of the event sequence number.

---