---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > XFC / V0-1-2

Constituent: hfcprint     Tag: mv2304

---

         

---

HFC_resultsPrint.h File Reference

Defines the interface for summarizing the event-by-event results of the heavy ion (CNO) filtering process. More...

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

Typedefs
typedef enum _HFC_RESULTS_PRINT_OPT_V	HFC_RESULTS_PRINT_OPT_V
	Typedef for enum _HFC_M_RESULTS_PRINT_OPT_V.
typedef enum _HFC_RESULTS_PRINT_OPT_M	HFC_RESULTS_PRINT_OPT_M
	Typedef for enum _HFC_RESULTS_PRINT_OPT_M.
Enumerations
enum	_HFC_RESULTS_PRINT_OPT_V {   HFC_RESULTS_PRINT_OPT_V_SUMMARY = 0,   HFC_RESULTS_PRINT_OPT_V_EVENT = 1 }
	Enumerates the print options for the HFC_resultsPrint routine as bit offsets. More...
enum	_HFC_RESULTS_PRINT_OPT_M {   HFC_RESULTS_PRINT_OPT_M_SUMMARY,   HFC_RESULTS_PRINT_OPT_M_EVENT,   HFC_RESULTS_PRINT_OPT_M_ALL = 0xffff }
	Enumerates the print options for the HFC_resultsPrint routine as bit masks. More...
Functions
int	HFC_resultsPrint (int options, const HFC_result *beg, const HFC_result *end)
	Prints the event-by-event result vector to the terminal.

---

Detailed Description

Defines the interface for summarizing the event-by-event results of the heavy ion (CNO) filtering process.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: HFC_resultsPrint.h,v 1.1.1.1 2006/06/13 22:18:24 russell Exp $

---

Enumeration Type Documentation

enum _HFC_RESULTS_PRINT_OPT_M

Enumerates the print options for the HFC_resultsPrint routine as bit masks. Enumerator: HFC_RESULTS_PRINT_OPT_M_SUMMARY  Print the summary information HFC_RESULTS_PRINT_OPT_M_EVENT  Print the event by event information HFC_RESULTS_PRINT_OPT_M_ALL  Print all the information

enum _HFC_RESULTS_PRINT_OPT_V

Enumerates the print options for the HFC_resultsPrint routine as bit offsets. Enumerator: HFC_RESULTS_PRINT_OPT_V_SUMMARY  Print the summary information HFC_RESULTS_PRINT_OPT_V_EVENT  Print event by event information

---

Function Documentation

int HFC_resultsPrint (  int  options, const HFC_result *  beg, const HFC_result *  end )

Prints the event-by-event result vector to the terminal. Returns: The number printed Parameters: options  An options vector, expressed as a bit mask, controlling how verbose the display is. beg  The first results vector to print. end  The ending results vector Currently only two options are supported HFC_RESULTS_PRINT_OPT_M_EVENT and HFC_RESULTS_PRINT_OPT_M_SUMMARY. These are documented in the interface file.

---