DFC_statsPrint.c File Reference

Provides routines to output the summary statistics of the Diagnostic filtering process. More...

#include <XFC/DFC_statsPrint.h>
#include <DFC_statsDef.h>
#include <DFC_def.h>
#include <XFC/DFC_status.h>
#include <DFC_resultDef.h>
#include <EDS/ECR_cal.h>
#include <stdio.h>
#include <string.h>

Defines
#define	ORDER_K_NEW_LINE   0xff
	Order to print a new line.
#define	ORDER_K_SUBTRACT   0xfe
	Order to subtract the next two values, title index is the 3rd.
Enumerations
enum	_TITLE_K { TITLE_K_ANY_VETO = (64 + 0) }
	Derived statistics titles. More...
Functions
static void	printHeader (const char *caption)
	Prints the header line of the statistics table.
static void	printBody (const DFC_stats *stats, unsigned int vetoes, const unsigned char(*titles)[][18], const unsigned char *orders, int cnt, int flag)
	Prints the body of the statistics table.
void	DFC_statsPrint (DFC_statsPrintCtx *ctx, const DFC_stats *stats, unsigned int vetoes)
	Prints the statistics block in ASCII format to standard output.
Variables
static const unsigned char	AllOrder []
	Indicates the order that the fields should be printed.

---

Detailed Description

Provides routines to output the summary statistics of the Diagnostic filtering process.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id#

---

Enumeration Type Documentation

enum _TITLE_K

Derived statistics titles.

Enumerator:

TITLE_K_ANY_VETO

Derived statistics ALL - NOT_VETOED

---

Function Documentation

void DFC_statsPrint	(	DFC_statsPrintCtx *	ctx,
		const DFC_stats *	stats,
		unsigned int	vetoes
	)

Prints the statistics block in ASCII format to standard output.

Parameters:

	ctx	The print context
	stats	The statistics block to print.
	vetoes	The active vetoes

References _DFC::cfg, _DFC_statsPrintCtx::dfc, printBody(), printHeader(), and _DFC_cfg::titles.

static void printBody	(	const DFC_stats *	stats,
		unsigned int	vetoes,
		const unsigned char(*)	titles[][18],
		const unsigned char *	orders,
		int	cnt,
		int	flag
	)			[static]

Prints the body of the statistics table.

Parameters:

	stats	The statistics to print.
	vetoes	The active vetoes
	titles	A set of titles to be associated with the statistics.
	orders	A series of orders selecting which statistics are to be printed from the cnts parameter and, by implication, the title string from the titles parameter. It also contains meta-commands like new line orders to aid in the readability
	cnt	The number of orders in the orders array.
	flag	Flag indicating to add the next group of 64 on

References _DFC_stats::cnts, ORDER_K_NEW_LINE, and ORDER_K_SUBTRACT.

Referenced by DFC_statsPrint().

static void printHeader

(

const char *

caption

)

[static]

Prints the header line of the statistics table.

Parameters:

caption

A short (< 9 characters) description of the statistics being described.

Referenced by DFC_statsPrint().

---

Variable Documentation

static const unsigned char AllOrder[] [static]

Initial value:

{
    STAT_K_STAGE_GEM,
    ORDER_K_NEW_LINE,

    STAT_K_STATUS_GEM_CLASS_0,
    STAT_K_STATUS_GEM_CLASS_1,
    STAT_K_STATUS_GEM_CLASS_2,
    STAT_K_STATUS_GEM_CLASS_3,
    STAT_K_STATUS_GEM_CLASS_4,
    STAT_K_STATUS_GEM_CLASS_5,
    STAT_K_STATUS_GEM_CLASS_6,
    STAT_K_STATUS_GEM_CLASS_7,
    STAT_K_STATUS_GEM_CLASS_8,
    STAT_K_STATUS_GEM_CLASS_9,
    STAT_K_STATUS_GEM_CLASS_A,
    STAT_K_STATUS_GEM_CLASS_B,
    STAT_K_STATUS_GEM_CLASS_C,
    STAT_K_STATUS_GEM_CLASS_D,
    STAT_K_STATUS_GEM_CLASS_E,
    STAT_K_STATUS_GEM_CLASS_F,
    STAT_K_STATUS_VETOED,
}

Indicates the order that the fields should be printed.

Indicates the order that the fields in the uncut statistical block should be printed. Special sentinal values indicating new lines and other control functions.