HFC_resultDef.h File Reference

Defines the data structure for summarizing the event-by-event results of the heavy ion filtering process. More...

#include <EDS/TMR.h>

Classes
struct	_HFC_result
	Describes the event-by-event results of the heavy ion filtering process for the instrumented and development version of the filtering code. More...
Defines
#define	tmr_store(_where)   _where = TMR_GET()
	In the instrumented version of the filter, this macro gets and stores the current time. In other versions, it is a NOOP.
#define	ievt_store(_where, _ievt)   _where = (_ievt)
	In the instrumented version of the filter, this macro stores current event number.
Typedefs
typedef struct _HFC_result	HFC_result
	Typedef for HFC_result.

---

Detailed Description

Defines the data structure for summarizing the event-by-event results of the heavy ion filtering process.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: HFC_resultDef.h,v 1.2 2011/03/28 20:50:57 russell Exp $

This defines two versions of the Heaver Result vector. One is a bare bones version used in flight, the other is used when instrumenting the filter for performance monitoring.

---

Define Documentation

#define ievt_store	(	_where,
		_ievt		)	_where = (_ievt)

In the instrumented version of the filter, this macro stores current event number.

Parameters:

	_where	Where to store the event number.
	_ievt	The event number to store

This macro is a NOOP in all but the instrumented version of the filter

#define tmr_store

(

_where

)

_where = TMR_GET()

In the instrumented version of the filter, this macro gets and stores the current time. In other versions, it is a NOOP.

Parameters:

_where

Where to store the time

This macro is a NOOP in all but the instrumented version of the filter

---

Typedef Documentation

HFC_result

Typedef for HFC_result.

Warning:

The documentation for this record is always generated as if it were for the instrumented and development filter. If one is using the the flyable version of the filter code, only the status and stageEnergy word are defined.