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

Constituent: hfcprint     Tag: mv2304


Interface   Data Structures   File List   Data Fields   Globals  

HFC_statsPrint.c File Reference

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

#include "XFC/HFC_statsPrint.h"
#include "HFC_statsDef.h"
#include "XFC/HFC_status.h"
#include "HFC_resultDef.h"
#include "EDS/ECR_cal.h"
#include <stdio.h>
#include <string.h>

Include dependency graph for HFC_statsPrint.c:


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 unsigned char *caption)
 Prints the header line of the statistics table.
static void printBody (const HFC_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 HFC_statsPrint (const HFC_stats *stats, unsigned int vetoes)
 Prints the statistics block in ASCII format to standard output.

Variables

static const unsigned char Titles [33][18]
 The title lines for each of the statistical quantities.
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 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 HFC_statsPrint const HFC_stats stats,
unsigned int  vetoes
 

Prints the statistics block in ASCII format to standard output.

Parameters:
stats The statistics block to print.
vetoes The active vetoes

static void printBody const HFC_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

static void printHeader const unsigned char *  caption  )  [static]
 

Prints the header line of the statistics table.

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


Variable Documentation

static const unsigned char AllOrder[] [static]
 

Initial value:

{
    STAT_K_STAGE_GEM,
    STAT_K_MULTI_PKT,
    STAT_K_STAGE_DIR,
    STAT_K_ERR_DIR,
    STAT_K_ERR_CTB,
    STAT_K_STAGE_CAL,
    STAT_K_ERR_CAL,
    STAT_K_STAGE_CAL_ECHK,
    STAT_K_STAGE_CAL_LCHK,
    ORDER_K_NEW_LINE,

    STAT_K_STATUS_GEM_NOCNO,
    STAT_K_STATUS_GEM_NOCALLO,
    STAT_K_STATUS_GEM_NOTKR,
    STAT_K_STATUS_LYR_ENERGY,
    STAT_K_STATUS_LYR_COUNTS,
    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.


Generated on Thu Jun 19 01:23:42 2008 by  doxygen 1.4.4