DFC_resultsPrint.h File Reference

Defines the interface for summarizing the event-by-event results of the Minimum Ionizing Particle (MIP) filtering process. More...

Typedefs
typedef enum _DFC_RESULTS_PRINT_OPT_V	DFC_RESULTS_PRINT_OPT_V
	Typedef for enum _DFC_M_RESULTS_PRINT_OPT_V.
typedef enum _DFC_RESULTS_PRINT_OPT_M	DFC_RESULTS_PRINT_OPT_M
	Typedef for enum _DFC_RESULTS_PRINT_OPT_M.
Enumerations
enum	_DFC_RESULTS_PRINT_OPT_V {   DFC_RESULTS_PRINT_OPT_V_SUMMARY = 0,   DFC_RESULTS_PRINT_OPT_V_EVENT = 1 }
	Enumerates the print options for the DFC_resultsPrint routine as bit offsets. More...
enum	_DFC_RESULTS_PRINT_OPT_M {   DFC_RESULTS_PRINT_OPT_M_SUMMARY,   DFC_RESULTS_PRINT_OPT_M_EVENT,   DFC_RESULTS_PRINT_OPT_M_ALL = 0xffff }
	Enumerates the print options for the DFC_resultsPrint routine as bit masks. More...
Functions
int	DFC_resultsPrint (int options, const DFC_result *beg, const DFC_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 Minimum Ionizing Particle (MIP) filtering process.

Author:

JJRussell - russell@slac.stanford.edu

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

---

Enumeration Type Documentation

enum _DFC_RESULTS_PRINT_OPT_M

Enumerates the print options for the DFC_resultsPrint routine as bit masks.

Enumerator:

DFC_RESULTS_PRINT_OPT_M_SUMMARY	Print the summary information
DFC_RESULTS_PRINT_OPT_M_EVENT	Print the event by event information
DFC_RESULTS_PRINT_OPT_M_ALL	Print all the information

enum _DFC_RESULTS_PRINT_OPT_V

Enumerates the print options for the DFC_resultsPrint routine as bit offsets.

Enumerator:

DFC_RESULTS_PRINT_OPT_V_SUMMARY	Print the summary information
DFC_RESULTS_PRINT_OPT_V_EVENT	Print event by event information

---

Function Documentation

int DFC_resultsPrint	(	int	options,
		const DFC_result *	beg,
		const DFC_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 DFC_RESULTS_PRINT_OPT_M_EVENT and DFC_RESULTS_PRINT_OPT_M_SUMMARY. These are documented in the interface file.

References _DFC_result::beg, DFC_RESULTS_PRINT_OPT_M_EVENT, DFC_RESULTS_PRINT_OPT_M_SUMMARY, DFC_STATUS_M_STAGE_GEM, _DFC_result::evtNum, _DFC_result::gem, and _DFC_result::status.